0.3.0

outcome/nz.adjmunro.outcome.outcome

Package-level declarations

Types

value class Failure<out Error : Any>(val error: Error) : Outcome<Nothing, Error>

A failed Outcome.

typealias Faulty<Error> = Outcome<Unit, Error>

Alias for a Outcome used when only the Error information is important.

typealias FaultyFlow<Error> = Flow<Faulty<Error>>

Alias for a flow of a faulty result.

typealias FaultyScope<Error> = RaiseScope<Error>.() -> Unit

Alias for a RaiseScope context runner used for Faulty.

typealias Maybe<Ok> = Outcome<Ok, Unit>

Alias for a Outcome used when only the Ok information is important.

typealias MaybeFlow<Ok> = Flow<Maybe<Ok>>

Alias for a flow of a maybe result.

typealias MaybeScope<Ok> = RaiseScope<Any>.() -> Ok

Alias for a RaiseScope context runner used for Maybe.

sealed interface Outcome<out Ok : Any, out Error : Any>

Represents either a Success or Failure state.

typealias OutcomeFlow<Ok, Error> = Flow<Outcome<Ok, Error>>

Alias for a flow of an outcome result.

typealias OutcomeScope<Ok, Error> = RaiseScope<Error>.() -> Ok

Alias for a RaiseScope context runner used for Outcome.

value class Success<out Ok : Any>(val value: Ok) : Outcome<Ok, Nothing>

A successful Outcome.