Data.Effect.Coroutine

This module provides effects for the coroutine, comes from Control.Monad.Freer.Coroutine in the freer-simple package (The continuation part (b -> c) has been removed. If necessary, please manually compose the Coyoneda) .

Documentation

data Yield a b c where

An effect for coroutines. Realizes an operation that transfers control to the caller of the computation with coroutines along with a value of type a, and receives a value of type b from the caller.

Constructors

Yield :: forall a b. a -> Yield a b b

Transfers control to the caller of the computation with coroutines along with a value of type a, and receives a value of type b from the caller.

type LYield a b = LiftFOE (Yield a b)

pattern LYield :: forall a1 b a2 f. () => (a1 ~ b, ()) => a2 -> LiftFOE (Yield a2 b) f a1

yield :: SendFOE (Yield a b) f => a -> f b

Transfers control to the caller of the computation with coroutines along with a value of type a, and receives a value of type b from the caller.

yield' :: forall {k} (tag :: k) a b f. SendFOE (Tag (Yield a b) tag) f => a -> f b

Transfers control to the caller of the computation with coroutines along with a value of type a, and receives a value of type b from the caller.

yield'' :: forall {k} (key :: k) a b f. SendFOEBy key (Yield a b) f => a -> f b

Transfers control to the caller of the computation with coroutines along with a value of type a, and receives a value of type b from the caller.

yield_ :: Yield a () <: f => a -> f ()

A version of yield where the value returned from the caller of the computation with coroutines is unit.

data Status (f :: Type -> Type) a b r

The execution result when handling a computation that includes the Yield effect. A computation that may include suspension. If the computation does not include yield, the completed result of the computation is obtained as Done. If the computation includes yield, execution is suspended at that point, and the value of type a thrown by yield and the continuation of the computation from the point of yield are obtained as Continue. By re-executing this continuation, you can resume the computation.

Constructors

Done r

The computation has completely finished

Continue a (b -> f (Status f a b r))

The computation has been suspended by yield

Instances

Functor f => Functor (Status f a b)

Defined in Data.Effect.Coroutine

Methods

fmap :: (a0 -> b0) -> Status f a b a0 -> Status f a b b0

(<$) :: a0 -> Status f a b b0 -> Status f a b a0

continueStatus

Arguments

:: Monad m

=> (x -> m (Status m a b r))

Additional continuation

-> Status m a b x

Computation status to extend

-> m (Status m a b r)

Extends the computation result by appending the specified continuation.

loopStatus

Arguments

:: Monad m

=> (a -> m b)

Handler to resume computation from a suspended state.

-> Status m a b r

A computation that may include suspension.

-> m r

Repeats the computation until the final result is obtained by continuing the computation using the specified handler each time it suspends.