Package-level declarations

Alias for Outcome used when only the error is useful — the success is irrelevant.

Alias for a Flow of Fault values.

Alias for Outcome used when only the success value is useful — the error is irrelevant.

Alias for a Flow of Maybe values.

Alias for a Flow of Outcome values.

Directly wraps any T as a Failure. No type inference or null-checks performed.

Converts any Outcome to a Fault by discarding the Success value (mapping it to Unit).

Converts any Outcome to a Maybe by discarding the Failure error (mapping it to Unit).

Converts a KotlinResult to an Outcome with Throwable as the error type.

Directly wraps any T as a Success. No type inference or null-checks performed.

Property alias for flattenNestedFailure.

Property alias for flattenNestedBoth.

Property alias for flattenNestedSuccess.

Smart-wraps any T as a Fault.

Smart-wraps any T as a Maybe.

Smart-wraps any T as an Outcome.

Combines every Outcome in the Iterable into a single result.

Transforms the Success value of this Outcome, wrapping the result with outcome error-catching semantics.

Conditionally transforms the Success value, but only when predicate returns true. If predicate returns false, the Success is returned unchanged.

Transforms the Success value of this Outcome, wrapping the result with outcomeOf error-catching semantics.

Conditionally transforms the Success value, but only when predicate returns true. If predicate returns false, the Success is returned unchanged.

Awaits the result of a Deferred and wraps it as a Fault.

Awaits the result of a Deferred and wraps it as a Maybe.

Awaits the result of a Deferred and wraps it as an Outcome.

Runs block and wraps the result as an Outcome, using Exception as the error type.

Suspend variant of catchException builder.

Runs block and wraps the result as an Outcome, using String as the error type.

Suspend variant of catchString builder.

Coerces this Outcome to a Failure.

Coerces this Outcome to a Success.

Extracts either the Success value or the Failure error, returning the nearest common Ancestor type.

Returns a Flow that collapses each Outcome to its nearest common Ancestor type.

Returns a Failure whose error is Unit. Convenient when a Maybe must signal absence without providing an error value.

Returns a Success whose value is Unit. Convenient when a Fault must signal success without providing a value.

Returns the Failure error, or default if the outcome is a Success.

Returns the Failure error, or the result of faulter applied to the Success value.

Returns the Failure error, or null if the outcome is a Success.

Returns the Failure error, or short-circuits the surrounding RaiseScope with the Success value.

Returns the Failure error, or throws if the outcome is a Success.

Builds a Failure whose error is the value returned by block.

Infix alias for coerceToFailure.

Runs block inside a RaiseScope and returns a Fault.

Suspend variant of fault builder.

Returns a Flow containing only the error of each Failure outcome. Success outcomes are filtered out.

Returns a Flow containing only the value of each Success outcome. Failure outcomes are filtered out.

Transforms Outcome<Ok, ErrorIn> into Outcome<Ok, ErrorOut> by applying transform to the Failure error.

Transforms Outcome<In, Error> into Outcome<Out, Error> by applying transform to the Success value.

Flattens nested Outcome values from both the Success and Failure states into a single Outcome.

Flattens a nested Outcome from inside the Failure state into a single Outcome.

Flattens a nested Outcome from inside the Success state into a single Outcome.

Applies success or failure to the receiver Outcome, returning Output.

Returns a Flow of Output by applying success or failure to each Outcome in the upstream flow.

Returns the Success value, or default if the outcome is a Failure.

Returns the Success value, or the result of recover applied to the Failure error.

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

Returns the Success value, or short-circuits the surrounding RaiseScope with the Failure error.

Returns the Success value, or throws if the outcome is a Failure.

Swaps the Success value and the Failure error, producing Outcome<Error, Ok>.

Returns true if this Outcome is a Failure.

Returns true if this is a Failure and predicate returns true for the error.

Returns true if this Outcome is a Success.

Returns true if this is a Success and predicate returns true for the value.

Transforms both states of an Outcome, re-wrapping each result in the same kind of Outcome.

Returns a new OutcomeFlow with each Failure error transformed by transform. Success outcomes pass through unaffected.

Transforms Outcome<Ok, ErrorIn> into Outcome<Ok, ErrorOut> by applying transform to the Failure error.

Returns a new OutcomeFlow with each Success value transformed by transform. Failure outcomes pass through unaffected.

Transforms Outcome<In, Error> into Outcome<Out, Error> by applying transform to the Success value.

Runs block inside a RaiseScope and returns a Maybe.

Suspend variant of maybe builder.

Returns an OutcomeFlow that invokes block for each Failure outcome before emitting it downstream. Success outcomes pass through unaffected.

Returns an OutcomeFlow that invokes block for each Success outcome before emitting it downstream. Failure outcomes pass through unaffected.

Calls block with the Failure error if this is a failure, then returns the original Outcome unchanged. No-op on Success.

Calls block with the Success value if this is a success, then returns the original Outcome unchanged. No-op on Failure.

Runs block inside a RaiseScope and returns an Outcome.

Suspend variant of outcome builder.

Infix alias for coerceToSuccess.

Reverse fold — identical behaviour with swapped lambda argument order.

Builds a Success whose value is the value returned by block.

Throws if this is a Failure and predicate returns true for the error. Returns the original Outcome unchanged otherwise.

Throws if this is a Failure and predicate returns false for the error. Returns the original Outcome unchanged otherwise.

Wraps this value as a Fault based on isFailure.

Wraps this value as a Maybe based on isSuccess.

Wraps this value as an Outcome based on a predicate.

Transforms a Failure into a Success, wrapping the result with outcome error-catching semantics.

Transforms a Failure into a Success, wrapping the result with outcomeOf error-catching semantics.