Moduleeffectful-core-2.7.1.2GHC2021

Effectful.Labeled.Output

Convenience functions for the Labeled Output effect.

3 types
6 values

Packageeffectful-core-2.7.1.2
Exports9
LanguageGHC2021
LicenceBSD-3-Clause
SourceOutput.hs

Effect

1 declaration

datadata Output o (a :: Type -> Type) b where

Provide the ability to feed values of type o to a handler.

Constructors

Output :: o -> Output o a ()

Instances1DispatchOf

type DispatchOf (Output o) = 'DynamicDefined in effectful-core-2.7.1.2 · Effectful.Output.Dynamic

Handlers

valuerunOutputAction

:: HasCallStack
=> (HasCallStack => o -> Eff es ())
The action for output generation.
-> Eff (Labeled label (Output o) ': es) a
-> Eff es a

Run the Output effect with the given action for receiving values.

valuerunOutputLocalArray

:: HasCallStack
=> Eff (Labeled label (Output o) ': es) a
-> Eff es (a, Array o)

Run the Output effect and return the final value along with the accumulated array (via Effectful.Output.Static.Local.Array).

valuerunOutputLocalList

:: HasCallStack
=> Eff (Labeled label (Output o) ': es) a
-> Eff es (a, [o])

Run the Output effect and return the final value along with the accumulated list (via Effectful.Output.Static.Local.List).

valuerunOutputSharedArray

:: HasCallStack
=> Eff (Labeled label (Output o) ': es) a
-> Eff es (a, Array o)

Run the Output effect and return the final value along with the accumulated array (via Effectful.Output.Static.Shared.Array).

valuerunOutputSharedList

:: HasCallStack
=> Eff (Labeled label (Output o) ': es) a
-> Eff es (a, [o])

Run the Output effect and return the final value along with the accumulated list (via Effectful.Output.Static.Shared.List).

Operations

valueoutput :: (HasCallStack, Labeled label (Output o) :> es) => o -> Eff es ()

Feed the value to the underlying handler.

Re-exports

2 declarations

newtypenewtype Labeled (label :: k) (e :: Effect) (a :: Type -> Type) b where

Assign a label to an effect.

Note: labeled effects are best used together with the effectful-plugin package, as it significantly improves their usability.

The constructor is for sending labeled operations of a dynamically dispatched effect to the handler:

Example1 expression

>>> import Effectful.Dispatch.Dynamic

Example1 expression

>>> :{  data X :: Effect where    X :: X m Int  type instance DispatchOf X = Dynamic:}

Example1 expression

>>> :{  runPureEff . runLabeled @"x" (interpret_ $ \X -> pure 333) $ do    send $ Labeled @"x" X:}333

Constructors

Labeled :: e a b -> Labeled label e a b

Instances2DispatchOf, StaticRep

type DispatchOf (Labeled label e) = DispatchOf eDefined in effectful-core-2.7.1.2 · Effectful.Labeled
data StaticRep (Labeled label e)Defined in effectful-core-2.7.1.2 · Effectful.Labeled

datadata Array a

Boxed arrays.

Instances26Monad, Functor, MonadFix, MonadFail, Applicative, Foldable, …

Monad ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Functor ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
MonadFix ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
MonadFail ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Applicative ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Foldable ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Traversable ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Alternative ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
MonadPlus ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
MonadZip ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Eq1 ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Ord1 ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Read1 ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Show1 ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
NFData1 ArrayDefined in primitive-0.9.1.0 · Data.Primitive.Array
Lift a => Lift (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
IsList (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Eq a => Eq (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Data a => Data (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Ord a => Ord (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Lexicographic ordering. Subject to change between major versions.
Read a => Read (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Show a => Show (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Semigroup (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
Monoid (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
NFData a => NFData (Array a)Defined in primitive-0.9.1.0 · Data.Primitive.Array
type Item (Array a) = aDefined in primitive-0.9.1.0 · Data.Primitive.Array