Android Scanbot SDK/io.scanbot.common/Result

Result

sealed interface Result<out T>

Inheritors

Success

Failure

Types

ComponentUnavailableError

class ComponentUnavailableError(message: String) : Result.Failure

Failure

sealed class Failure : Throwable, Result<Nothing>

IllegalStateError

class IllegalStateError(message: String) : Result.Failure

InvalidArgumentError

class InvalidArgumentError(message: String) : Result.Failure

InvalidDataError

class InvalidDataError(message: String) : Result.Failure

InvalidImageRefError

class InvalidImageRefError(message: String) : Result.Failure

InvalidLicenseError

class InvalidLicenseError(message: String = "License requirements are not satisfied.") : Result.Failure

IoError

class IoError(message: String) : Result.Failure

NullPointerError

class NullPointerError(message: String) : Result.Failure

OperationCanceledError

class OperationCanceledError(message: String) : Result.Failure

OutOfMemoryError

class OutOfMemoryError(message: String) : Result.Failure

Success

data class Success<out T>(val data: T) : Result<T>

TimeoutError

class TimeoutError(message: String) : Result.Failure

UnknownError

class UnknownError(message: String) : Result.Failure

Functions

errorOrNull

open fun errorOrNull(): Result.Failure?

flatmap

fun <T> Result<Collection<Result<T>>>.flatmap(): Collection<Result<T>>

getOrDefault

fun <T> Result<T>.getOrDefault(default: T): T

getOrNull

open fun getOrNull(): T?

getOrThrow

open fun getOrThrow(): T

mapFailure

inline fun <T, R> Result<T>.mapFailure(block: ReturnBlockScope.(Result.Failure) -> R): Result<R>

mapResult

inline fun <T, R> Result<T>.mapResult(block: ReturnBlockScope.(Result<T>) -> Result<R>): Result<R>

mapSuccess

inline fun <T, R> Result<T>.mapSuccess(block: ReturnBlockScope.(T) -> R): Result<R>

onCancellation

inline fun <T> Result<T>.onCancellation(block: ReturnBlockScope.(Result.OperationCanceledError) -> Unit): Result<T>

onFailure

inline fun <T> Result<T>.onFailure(block: ReturnBlockScope.(Result.Failure) -> Unit): Result<T>

inline fun <T, R : Result.Failure> Result<T>.onFailure(clazz: Class<R>, block: ReturnBlockScope.(R) -> Unit): Result<T>

onSuccess

inline fun <T> Result<T>.onSuccess(block: ReturnBlockScope.(T) -> Unit): Result<T>