Krosstalk Core/com.rnett.krosstalk.result

Package com.rnett.krosstalk.result

APIs for KrosstalkResult. See the instructions on error handling.

Types

KrosstalkHttpError

class KrosstalkHttpError(httpError: KrosstalkResult.HttpError) : KrosstalkException

An exception representing a non-success HTTP error code from a Krosstalk method.

KrosstalkResult

interface KrosstalkResult<out T>

The result of a krosstalk call. Can be either an exception in the server method, a Http error, or success.

KrosstalkServerException

class KrosstalkServerException(exception: KrosstalkResult.ServerException) : KrosstalkException

An exception representing an exception on the server side (i.e. a HTTP 500 response, but with more information).

KrosstalkUncaughtServerException

class KrosstalkUncaughtServerException @InternalKrosstalkApi constructor(exception: KrosstalkResult.ServerException) : KrosstalkException

An exception representing an exception on the server side (i.e. a HTTP 500 response, but with more information).

Functions

catchKrosstalkExceptions

inline fun <T> catchKrosstalkExceptions(block: () -> T): KrosstalkResult<T>

Catch and unwrap KrosstalkServerException and KrosstalkHttpError, without converting other exceptions to KrosstalkServerException.

fold

inline fun <T, R> KrosstalkResult<T>.fold(onSuccess: (KrosstalkResult.Success<T>) -> R, onFailure: (KrosstalkResult.Failure) -> R): R

inline fun <T, R> KrosstalkResult<T>.fold(onSuccess: (KrosstalkResult.Success<T>) -> R, onHttpError: (KrosstalkResult.HttpError) -> R, onServerException: (KrosstalkResult.ServerException) -> R): R

Get a value depending on the type of result.

foldHttpError

inline fun <T, R> KrosstalkResult.SuccessOrHttpError<T>.foldHttpError(onSuccess: (KrosstalkResult.Success<T>) -> R, onHttpError: (KrosstalkResult.HttpError) -> R): R

Get a value depending on the type of result.

foldServerException

inline fun <T, R> KrosstalkResult.SuccessOrServerException<T>.foldServerException(onSuccess: (KrosstalkResult.Success<T>) -> R, onServerException: (KrosstalkResult.ServerException) -> R): R

Get a value depending on the type of result.

getOrDefault

inline fun <R, T : R> KrosstalkResult<T>.getOrDefault(onFailure: R): R

Get the value on success, or onFailure otherwise.

inline fun <R, T : R> KrosstalkResult<T>.getOrDefault(onServerException: R, onHttpError: R): R

Get the value on success, onServerException on a server exception, or onHttpError on a http error.

getOrElse

inline fun <R, T : R> KrosstalkResult<T>.getOrElse(onFailure: (KrosstalkResult.Failure) -> R): R

Gets the value on success, or the result of onFailure otherwise.

inline fun <R, T : R> KrosstalkResult<T>.getOrElse(onServerException: (KrosstalkResult.ServerException) -> R, onHttpError: (KrosstalkResult.HttpError) -> R): R

Get the value on success, onServerException on a server exception, or onHttpError on a http error.

getOrElseHttpError

inline fun <R, T : R> KrosstalkResult.SuccessOrHttpError<T>.getOrElseHttpError(onHttpError: (KrosstalkResult.HttpError) -> R): R

Gets the value on success, or the result of onFailure otherwise.

getOrElseServerException

inline fun <R, T : R> KrosstalkResult.SuccessOrServerException<T>.getOrElseServerException(onServerException: (KrosstalkResult.ServerException) -> R): R

Gets the value on success, or the result of onFailure otherwise.

handleHttpError

inline fun <R, T : R> KrosstalkResult.SuccessOrHttpError<T>.handleHttpError(filter: (KrosstalkResult.HttpError) -> Boolean, onHttpError: (KrosstalkResult.HttpError) -> R): KrosstalkResult.SuccessOrHttpError<R>

inline fun <R, T : R> KrosstalkResult<T>.handleHttpError(filter: (KrosstalkResult.HttpError) -> Boolean, onHttpError: (KrosstalkResult.HttpError) -> R): KrosstalkResult<R>

Handle http errors matching filter.

inline fun <R, T : R> KrosstalkResult.SuccessOrHttpError<T>.handleHttpError(statusCode: Int, onHttpError: (KrosstalkResult.HttpError) -> R): KrosstalkResult.SuccessOrHttpError<R>

inline fun <R, T : R> KrosstalkResult<T>.handleHttpError(statusCode: Int, onHttpError: R): KrosstalkResult<R>

inline fun <R, T : R> KrosstalkResult<T>.handleHttpError(statusCode: Int, onHttpError: (KrosstalkResult.HttpError) -> R): KrosstalkResult<R>

Handle http errors with status codes of statusCode.

handleServerException

inline fun <R, T : R> KrosstalkResult.SuccessOrServerException<T>.handleServerException(filter: (KrosstalkResult.ServerException) -> Boolean, onServerException: (KrosstalkResult.ServerException) -> R): KrosstalkResult.SuccessOrServerException<R>

inline fun <R, T : R> KrosstalkResult<T>.handleServerException(filter: (KrosstalkResult.ServerException) -> Boolean, onServerException: (KrosstalkResult.ServerException) -> R): KrosstalkResult<R>

Handle server exceptions matching filter.

inline fun <R, T : R> KrosstalkResult.SuccessOrServerException<T>.handleServerException(className: String, onServerException: (KrosstalkResult.ServerException) -> R): KrosstalkResult.SuccessOrServerException<R>

Handle server exceptions with a KrosstalkResult.ServerException.className of className.

inline fun <R, T : R> KrosstalkResult<T>.handleServerException(className: String, onServerException: (KrosstalkResult.ServerException) -> R): KrosstalkResult<R>

Handle server exceptions with a KrossalkResult.ServerException.className of className.

handleServerExceptionAsHttpError

inline fun <T> KrosstalkResult<T>.handleServerExceptionAsHttpError(filter: (KrosstalkResult.ServerException) -> Boolean, onServerException: (KrosstalkResult.ServerException) -> KrosstalkResult.HttpError): KrosstalkResult<T>

Handle server exceptions matching filter as http errors.

inline fun <T> KrosstalkResult<T>.handleServerExceptionAsHttpError(filter: (KrosstalkResult.ServerException) -> Boolean, statusCode: Int): KrosstalkResult<T>

Handle server exceptions matching filter as http errors with status code statusCode and a message of KrossalkResult.ServerException.asString.

inline fun <T> KrosstalkResult<T>.handleServerExceptionAsHttpError(className: String, onServerException: (KrosstalkResult.ServerException) -> KrosstalkResult.HttpError): KrosstalkResult<T>

Handle server exceptions with class names of className as http errors.

inline fun <T> KrosstalkResult<T>.handleServerExceptionAsHttpError(className: String, statusCode: Int): KrosstalkResult<T>

Handle server exceptions with class names of className as http errors with status code statusCode and a message of KrossalkResult.ServerException.asString.

isFailure

inline fun <T> KrosstalkResult<T>.isFailure(): Boolean

Whether the result is not a success.

isHttpError

inline fun <T> KrosstalkResult<T>.isHttpError(): Boolean

Whether the result is a http error.

isServerException

inline fun <T> KrosstalkResult<T>.isServerException(): Boolean

Whether the result is a server exception.

isSuccess

inline fun <T> KrosstalkResult<T>.isSuccess(): Boolean

Whether the result is success.

map

inline fun <T, R> KrosstalkResult.SuccessOrHttpError<T>.map(transform: (T) -> R): KrosstalkResult.SuccessOrHttpError<R>

inline fun <T, R> KrosstalkResult.SuccessOrServerException<T>.map(transform: (T) -> R): KrosstalkResult.SuccessOrServerException<R>

inline fun <T, R> KrosstalkResult<T>.map(transform: (T) -> R): KrosstalkResult<R>

Transform the success value.

recoverHttpErrors

inline fun <R, T : R> KrosstalkResult.SuccessOrHttpError<T>.recoverHttpErrors(onHttpError: (KrosstalkResult.HttpError) -> R): R

Recover from all http errors. Note that exceptions will not be caught, so KrosstalkResult.HttpError.throwFailureException can be used to throw on unhandled http errors.

inline fun <R, T : R> KrosstalkResult<T>.recoverHttpErrors(onHttpError: (KrosstalkResult.HttpError) -> R): KrosstalkResult.SuccessOrServerException<R>

Recover from all http errors. Note that exceptions will not be caught, so KrossalkResult.HttpError.throwFailureException can be used to throw on unhandled http errors.

recoverServerExceptions

inline fun <R, T : R> KrosstalkResult.SuccessOrServerException<T>.recoverServerExceptions(onServerException: (KrosstalkResult.ServerException) -> R): R

Recover from all server exceptions. Note that exceptions will not be caught, so KrosstalkResult.ServerException.throwFailureException can be used to throw on unhandled server exceptions.

inline fun <R, T : R> KrosstalkResult<T>.recoverServerExceptions(onServerException: (KrosstalkResult.ServerException) -> R): KrosstalkResult.SuccessOrHttpError<R>

Recover from all server exceptions. Note that exceptions will not be caught, so KrossalkResult.ServerException.throwFailureException can be used to throw on unhandled server exceptions.

recoverServerExceptionsToResult

inline fun <R, T : R> KrosstalkResult<T>.recoverServerExceptionsToResult(onServerException: (KrosstalkResult.ServerException) -> KrosstalkResult.SuccessOrHttpError<R>): KrosstalkResult.SuccessOrHttpError<R>

Recover from all server exceptions, converting them to a successful value or a http error.

runKrosstalkCatching

inline fun <T> runKrosstalkCatching(includeStackTrace: Boolean = true, block: () -> T): KrosstalkResult<T>

Runs block and wraps the result if it is a success. If block throws, it wraps the resulting exception in KrosstalkResult.ServerException.

throwKrosstalkHttpError

inline fun throwKrosstalkHttpError(statusCode: Int, message: String? = null): Nothing

Throw a KrosstalkHttpError.

throwKrosstalkServerException

inline fun throwKrosstalkServerException(throwable: Throwable, includeStackTrace: Boolean = true): Nothing

Throw a KrosstalkServerException.

throwOnFailure

fun <T> KrosstalkResult<T>.throwOnFailure(): T

If this is a KrosstalkResult.HttpError, throw KrosstalkHttpError. If this is a KrosstalkResult.ServerException, throw KrosstalkServerException.

throwOnHttpError

fun <T> KrosstalkResult.SuccessOrHttpError<T>.throwOnHttpError(): T

fun <T> KrosstalkResult<T>.throwOnHttpError(): KrosstalkResult.SuccessOrServerException<T>

If this is a KrosstalkResult.HttpError, throw KrosstalkHttpError.

throwOnServerException

fun <T> KrosstalkResult.SuccessOrServerException<T>.throwOnServerException(): T

fun <T> KrosstalkResult<T>.throwOnServerException(): KrosstalkResult.SuccessOrHttpError<T>

If this is a KrosstalkResult.ServerException, throw KrosstalkServerException.

toKrosstalkResult

inline fun <T> Result<T>.toKrosstalkResult(includeStackTrace: Boolean = true): KrosstalkResult<T>

Convert a Result to a KrosstalkResult, using KrosstalkResult.ServerException to represent a failure.

toResult

inline fun <T> KrosstalkResult<T>.toResult(): Result<T>

Convert to a Result, using the KrosstalkHttpError or KrosstalkServerException exceptions.

Properties

failureOrNull

val <T> KrosstalkResult<T>.failureOrNull: KrosstalkResult.Failure?

Get the failure if there is one, else null

httpErrorOrNull

val <T> KrosstalkResult<T>.httpErrorOrNull: KrosstalkResult.HttpError?

Get the http error if there is one, else null

serverExceptionOrNull

val <T> KrosstalkResult<T>.serverExceptionOrNull: KrosstalkResult.ServerException?

Get the server exception if there is one, else null

valueOrNull

val <T> KrosstalkResult<T>.valueOrNull: T?

Get the value if successful, else null

valueOrThrow

val <T> KrosstalkResult<T>.valueOrThrow: T

Get the value if successful, otherwise throw with throwOnFailure