arrow-core/arrow.core.continuations/EffectScope

EffectScope

interface EffectScope<in R>(source)

Context of the Effect DSL.

Functions

attempt

open suspend fun <E, A> attempt(f: suspend EffectScope<E>.() -> A): suspend EffectScope<E>.() -> A

Encloses an action for which you want to catch any shift. attempt is used in combination with catch.

bind

open suspend fun Either<R, B>.bind(): B

Folds Either into Effect, by returning B or a shift with R.

open suspend fun Validated<R, B>.bind(): B

Folds Validated into Effect, by returning B or a shift with R.

open suspend fun EagerEffect<R, B>.bind(): B

Runs the EagerEffect to finish, returning B or shift in case of R, bridging eager computations into suspending.

open suspend fun Effect<R, B>.bind(): B

Runs the Effect to finish, returning B or shift in case of R.

open suspend fun Option.bind(shift: () -> R): B

Folds Option into Effect, by returning B or a transforming None into R and shifting the result.

open suspend fun Result.bind(transform: (Throwable) -> R): B

Folds Result into Effect, by returning B or a transforming Throwable into R and shifting the result.

catch

open infix suspend fun <E, A> suspend EffectScope<E>.() -> A.catch(recover: suspend EffectScope<R>.(E) -> A): A

When the Effect has shifted with R it will recover the shifted value to A, and when it ran the computation to completion it will return the value A. catch is used in combination with attempt.

ensure

open suspend fun ensure(condition: Boolean, shift: () -> R)

ensure that condition is true, if it's false it will shift with the provided value R. Monadic version of kotlin.require.

shift

abstract suspend fun shift(r: R): B

Short-circuit the Effect computation with value R.

Inheritors

Extensions

ensureNotNull

suspend fun <R, B : Any> EffectScope<R>.ensureNotNull(value: B?, shift: () -> R): B

Ensure that value is not null. if it's non-null it will be smart-casted and returned if it's false it will shift with the provided value R. Monadic version of kotlin.requireNotNull.