BLE-X/io.github.romantsisyk.blex.result/BleResult/Failure

Failure

data class Failure(val error: BleException) : BleResult<Nothing>

Represents a failed BLE operation result.

Constructors

Failure

constructor(error: BleException)

Properties

error

val error: BleException

The BleException describing the failure.

isFailure

val isFailure: Boolean

Returns true if this result represents a failed operation.

isSuccess

val isSuccess: Boolean

Returns true if this result represents a successful operation.

Functions

exceptionOrNull

fun exceptionOrNull(): BleException?

Returns the exception if this is a Failure, or null if this is a Success.

flatMap

inline fun <R> flatMap(transform: (Nothing) -> BleResult<R>): BleResult<R>

Transforms the success value using a function that returns a BleResult.

fold

inline fun <R> fold(onSuccess: (Nothing) -> R, onFailure: (BleException) -> R): R

Folds the result into a single value by applying the appropriate function.

getOrDefault

fun getOrDefault(defaultValue: Nothing): Nothing

Returns the success value if this is a Success, or the defaultValue if this is a Failure.

getOrElse

inline fun getOrElse(defaultValue: (BleException) -> Nothing): Nothing

Returns the success value if this is a Success, or the result of defaultValue if this is a Failure.

getOrNull

fun getOrNull(): Nothing?

Returns the success value if this is a Success, or null if this is a Failure.

getOrThrow

fun getOrThrow(): Nothing

Returns the success value if this is a Success, or throws the exception if this is a Failure.

map

inline fun <R> map(transform: (Nothing) -> R): BleResult<R>

Transforms the success value using the given transform function.

mapError

inline fun mapError(transform: (BleException) -> BleException): BleResult<Nothing>

Transforms the error using the given transform function.

onFailure

inline fun onFailure(action: (BleException) -> Unit): BleResult<Nothing>

Performs the given action if this is a Failure.

onSuccess

inline fun onSuccess(action: (Nothing) -> Unit): BleResult<Nothing>

Performs the given action if this is a Success.

recover

inline fun recover(recovery: (BleException) -> Nothing): BleResult<Nothing>

Recovers from a failure by providing an alternative success value.

recoverWith

inline fun recoverWith(recovery: (BleException) -> BleResult<Nothing>): BleResult<Nothing>

Attempts to recover from a failure using another BleResult.

zip

fun <T, R> BleResult<T>.zip(other: BleResult<R>): BleResult<Pair<T, R>>

Combines two BleResult instances into a single result containing a Pair.