Control.Monad.Coroutine.SuspensionFunctors

This module defines suspension functors for use with the Control.Monad.Coroutine module.

Suspension functors

data Yield x y

The Yield functor instance is equivalent to (,) but more descriptive.

Constructors

Yield x y

Instances

Functor (Yield x)

newtype Await x y

The Await functor instance is equivalent to (->) but more descriptive.

Constructors

Await (x -> y)

Instances

Functor (Await x)

data Request request response x

The Request functor instance combines a Yield of a request with an Await for a response.

Constructors

Request request (response -> x)

Instances

Functor (Request x f)

data EitherFunctor l r x

Combines two alternative functors into one, applying one or the other. Used for nested coroutines.

Constructors

LeftF (l x)

RightF (r x)

Instances

(Functor l, Functor r) => Functor (EitherFunctor l r)

(Functor p, Functor s) => ChildFunctor (EitherFunctor p s)

yield :: Monad m => x -> Coroutine (Yield x) m ()

Suspend yielding a value.

await :: Monad m => Coroutine (Await x) m x

Suspend until a value is provided.

request :: Monad m => x -> Coroutine (Request x y) m y

Suspend yielding a request and awaiting the response.