Moduleeffectful-core-2.7.1.2GHC2021

Effectful.Labeled.Provider.List

Convenience functions for the Labeled ProviderList effect.

3 types
1 class
6 values

Packageeffectful-core-2.7.1.2
Exports11
LanguageGHC2021
LicenceBSD-3-Clause
SourceList.hs

Effect

2 declarations

datadata ProviderList (providedEs :: [Effect]) input (f :: Type -> Type) (a :: Type -> Type) b where

Provide a way to run a handler of multiple providedEs with a given input.

Note: f can be used to alter the return type of the handler. If that's unnecessary, use ProviderList_.

Constructors

ProvideListWith :: input -> Eff (providedEs ++ es) a -> ProviderList providedEs input f a (f a)
Run the effect handlers with a given input.

Instances1DispatchOf

type DispatchOf (ProviderList providedEs input f) = 'DynamicDefined in effectful-core-2.7.1.2 · Effectful.Provider.List

typetype ProviderList_ (providedEs :: [Effect]) input = ProviderList providedEs input Identity

A restricted variant of ProviderList with unchanged return type of the handler.

Handlers

valuerunProviderList

:: (HasCallStack, KnownSubset providedEs (providedEs ++ es))
=> (forall r. HasCallStack => input -> Eff (providedEs ++ es) r -> Eff es (f r))
The handler.
-> Eff (Labeled label (ProviderList providedEs input f) ': es) a
-> Eff es a

Run the labeled ProviderList effect with a given handler.

valuerunProviderList_

:: (HasCallStack, KnownSubset providedEs (providedEs ++ es))
=> (forall r. HasCallStack => input -> Eff (providedEs ++ es) r -> Eff es r)
The handler.
-> Eff (Labeled label (ProviderList_ providedEs input) ': es) a
-> Eff es a

Run the labeled ProviderList effect with a given handler that doesn't change its return type.

Operations

valueprovideList

:: (HasCallStack, Labeled label (ProviderList providedEs () f) :> es)
=> Eff (providedEs ++ es) a
-> Eff es (f a)

Run the handler.

valueprovideList_

:: (HasCallStack, Labeled label (ProviderList_ providedEs ()) :> es)
=> Eff (providedEs ++ es) a
-> Eff es a

Run the handler with unchanged return type.

valueprovideListWith

:: (HasCallStack, Labeled label (ProviderList providedEs input f) :> es)
=> input
The input to the handler.
-> Eff (providedEs ++ es) a
-> Eff es (f a)

Run the handler with a given input.

valueprovideListWith_

:: (HasCallStack, Labeled label (ProviderList_ providedEs input) :> es)
=> input
The input to the handler.
-> Eff (providedEs ++ es) a
-> Eff es a

Run the handler that doesn't change its return type with a given input.

Re-exports

3 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 m a -> 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

familytype family (++) (xs :: [Effect]) (ys :: [Effect]) :: [Effect] where

Append two type-level lists together.

Equations

(++) '[] ys = ys
(++) (x ': xs) ys = x ': xs ++ ys

classclass Subset subEs es => KnownSubset (subEs :: [Effect]) (es :: [Effect])

Provide evidence that subEs is a known subset of es.

Instances2KnownSubset

KnownSubset '[] esDefined in effectful-core-2.7.1.2 · Effectful.Internal.Effect
(e :> es, KnownSubset subEs es) => KnownSubset (e ': subEs) esDefined in effectful-core-2.7.1.2 · Effectful.Internal.Effect