Effectful.Provider.List

Turn a handler of multiple effects into an effectful operation.

Generalizes Effectful.Provider.

Since: 2.3.1.0

Effect

data ProviderList (providedEs :: [Effect]) (input :: Type) (f :: Type -> Type) :: Effect

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_.

Instances

type DispatchOf (ProviderList providedEs input f)

Defined in Effectful.Provider.List

type DispatchOf (ProviderList providedEs input f) = 'Static 'NoSideEffects

data StaticRep (ProviderList providedEs input f)

Defined in Effectful.Provider.List

data StaticRep (ProviderList providedEs input f) where

• ProviderList :: forall (providedEs :: [Effect]) (handlerEs :: [Effect]) input (f :: Type -> Type). KnownEffects providedEs => !(Env handlerEs) -> !(ProviderListImpl input f providedEs handlerEs) -> StaticRep (ProviderList providedEs input f)

type ProviderList_ providedEs input = ProviderList providedEs input Identity

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

Handlers

runProviderList

Arguments

:: (HasCallStack, KnownEffects providedEs)

=> (forall r. HasCallStack => input -> Eff (providedEs ++ es) r -> Eff es (f r))

The handler.

-> Eff (ProviderList providedEs input f : es) a

-> Eff es a

Run the ProviderList effect with a given handler.

runProviderList_

Arguments

:: (HasCallStack, KnownEffects providedEs)

=> (forall r. HasCallStack => input -> Eff (providedEs ++ es) r -> Eff es r)

The handler.

-> Eff (ProviderList_ providedEs input : es) a

-> Eff es a

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

Operations

provideList :: forall providedEs f es a. (HasCallStack, ProviderList providedEs () f :> es) => Eff (providedEs ++ es) a -> Eff es (f a)

Run the handler.

provideList_ :: forall providedEs es a. (HasCallStack, ProviderList_ providedEs () :> es) => Eff (providedEs ++ es) a -> Eff es a

Run the handler with unchanged return type.

provideListWith

Arguments

:: forall providedEs input f es a. (HasCallStack, 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.

provideListWith_

Arguments

:: forall providedEs input es a. (HasCallStack, 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.

Misc

type family (xs :: [Effect]) ++ (ys :: [Effect]) :: [Effect] where ... infixr 5

Append two type-level lists together.

Equations

'[] ++ ys = ys

(x : xs) ++ ys = x : (xs ++ ys)

class KnownEffects (es :: [Effect])

Calculate length of a list of known effects.

Instances

KnownEffects ('[] :: [Effect])

Defined in Effectful.Internal.Effect

Methods

knownEffectsLength :: Int

KnownEffects es => KnownEffects (e ': es)

Defined in Effectful.Internal.Effect

Methods

knownEffectsLength :: Int