Package-level declarations

A class that represents a result of an operation.

Exception representing unsatisfied condition when using errorIf

An exception that is thrown when an attempt to retrieve a result of an ApiResult is being made when the result is Loading

Create an ApiResult from this value, based on the type of it.

ApiResult.Error.e's cause

ApiResult.Error.e's message.

ApiResult.Error.e's stack trace as string

Accumulates all errors from this collection and splits them into two lists:

Alias for map that takes this as a parameter

Emits Loading before this flow starts to be collected. Then maps all results to their values, then catches Exceptions and maps them to Errors

Catches Exceptions only and rethrows kotlin.Throwables (like kotlin.Errors).

Call another and retrieve the result. If the result is success, continue (the result of calling another is discarded). If the result is an error, propagate it to this. Effectively, requires for another ApiResult to succeed before proceeding with this one.

Makes this an Error if predicate returns true

Makes this an error if the collection is empty.

Makes this result an Error if this result is Loading

Make this result an Error if Success value was null.

Makes this an Error if predicate returns false

Filter the underlying collection.

Filter the underlying sequence.

Returns only error values

Filters all null values of results

Returns only successful values

Return the first successful value, or an Error if no success was found

Return the first successful value, or null if no success was found

Return the first successful value, or throw if no success was found

Call another and if it succeeds, continue with another's result. If it fails, propagate the error. An alias for then.

Emits ApiResult.Loading, then executes result

Fold this returning the result of onSuccess or onError By default, maps Loading to Error with NotFinishedException

Execute block if this's collection is empty.

Change the type of the Success to R without affecting Error/Loading results

Map both Error and Success. Does not affect Loading

Map the exception of the Error state, but only if this exception is of type R. Loading and Success are unaffected

Change the exception of the Error response without affecting loading/success results

Maps every Error in this using transform

Maps the error of the result, if present, to its cause, or self if cause is not available

Maps Loading to a Success, not affecting other states.

Map the Success result using transform, and if the result is not a success, return default

Maps each value in the collection, wrapping each map operation in an ApiResult

Maps every item of this using transform

Maps each success value of this flow using transform

Executes ApiResult.map on each value of the collection

Executes ApiResult.map on each value of the sequence

Merges all results into a single List, or if any has failed, returns Error.

Merges all results into a single List, or if any has failed, returns Error.

Merges this results and all other results into a single result of type T.

Maps Error values to nulls

Invokes block each time this flow emits an ApiResult.Success value

Invokes block each time this flow emits an ApiResult.Success value

Execute block if this's collection is empty.

Invoke a given block if this is Error and it's Error.e is of type E.

Invoke a given block if this is Error

Invoke given block if this is Loading

Invoke a given block if this is Success

If this is Error or Loading, returns defaultValue.

Executes block if this is an ApiResult.Error, otherwise returns ApiResult.value.

Returns emptyList if this's collection is empty

Returns emptyList if this's list is empty

Returns emptyMap if this's map is empty

Maps this flow to an ApiResult.Success value, otherwise the value is null

Maps this flow to an ApiResult.Success value, otherwise throws the resulting error

Throws ApiResult.Error.e, or NotFinishedException if the request has not been completed yet.

Recover from an exception of type R, else no-op. Does not affect Loading.

Recover from an exception. Does not affect Loading See also the typed version of this function to recover from a specific exception type

Recover from an Error only if the condition is true, else no-op. Does not affect Loading

Alias for orThrow

Makes this an error with ConditionNotSatisfiedException using specified message if the predicate returns false.

Alias for errorOnNull

Throws if this result is an Error and Error.e is of type T. Ignores all other exceptions.

Throws CancellationExceptions if this is an Error.

Executes block, wrapping it in an ApiResult

Execute block wrapping it in an ApiResult

Run block with a given context, catching any exceptions both in the block and nested coroutines. block will not return until all nested launched coroutines, if any, return. For the other type of behavior, use ApiResult.invoke directly. A failure of a child does not cause the scope to fail and does not affect its other children. A failure of the scope itself (exception thrown in the block or external cancellation) fails the result with all its children, but does not cancel parent job.

Call another and if it succeeds, continue with another's result. If it fails, propagate the error. Effectively, flatMap to another result.

Call block, wrapping it in an ApiResult, and then discard the Success value, but propagate Errors.

Emits ApiResult.Loading, then executes call and wraps it.

Change the type of successful result to R, also wrapping block in another result then folding it (handling exceptions)

calls recover catching and wrapping any exceptions thrown inside block.

Calls recover catching and wrapping any exceptions thrown inside block.

Recover from an Error only if the condition is true, else no-op. Does not affect Loading

Map this result to Unit, discarding the value

Unwrap an ApiResult<ApiResult<T>> to become ApiResult<T>

Returns a list of only successful values, discarding any errors