arrow-core/arrow.core.continuations/EagerEffectScope

EagerEffectScope

interface EagerEffectScope<in R>

Context of the EagerEffect DSL.

Functions

attempt

open suspend fun <E, A> attempt(f: suspend EagerEffectScope<E>.() -> A): suspend EagerEffectScope<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 EagerEffect, by returning B or a shift with R.

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

Folds Validated into EagerEffect, 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.

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

Folds Option into EagerEffect, 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 EagerEffect, by returning B or a transforming Throwable into R and shifting the result.

catch

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

When the EagerEffect 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 EagerEffect computation with value R.

Inheritors

IorEagerEffectScope

NullableEagerEffectScope

OptionEagerEffectScope

ResultEagerEffectScope

Extensions

ensureNotNull

suspend fun <R, B : Any> EagerEffectScope<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.