sdk-common / com.tomtom.online.sdk.common / Result

Result

sealed class Result<out T>

Class that represents the parse result which can be Success or Failure.

Types

Failure

class Failure<T> : Result<T>

Represents a failed operation that resulted in a Throwable.

Success

class Success<T> : Result<T>

Represents a successful operation that resulted in a returned T.

Functions

cause

abstract fun cause(): Throwable

Returns Throwable if the result is Failure.

isFailure

abstract fun isFailure(): Boolean

Returns true if Result finished with failure.

isSuccess

abstract fun isSuccess(): Boolean

Returns true if Result finished successfully.

value

abstract fun value(): T

Returns a value if the result is Success.

Companion Object Functions

failure

fun <T> failure(throwable: Throwable): Result<T>

Creates a Result.Failure from the given Throwable.

success

fun <T> success(value: T): Result<T>

Creates Result.Success from the given value.

Inheritors

Failure

class Failure<T> : Result<T>

Represents a failed operation that resulted in a Throwable.

Success

class Success<T> : Result<T>

Represents a successful operation that resulted in a returned T.