Safe Haskell	Safe-Inferred
Language	GHC2021

Effectful.Provider.List

Contents

Effect
- Handlers
- Operations
Misc

Description

Turn a handler of multiple effects into an effectful operation.

Generalizes Effectful.Provider.

Since: 2.3.1.0

Synopsis

data ProviderList (providedEs :: [Effect]) (input :: Type) (f :: Type -> Type) :: Effect where
- ProvideListWith :: forall providedEs input f es a. input -> Eff (providedEs ++ es) a -> ProviderList providedEs input f (Eff es) (f a)
type ProviderList_ providedEs input = ProviderList providedEs input Identity
runProviderList :: forall providedEs input f es a. (HasCallStack, KnownSubset providedEs (providedEs ++ es)) => (forall r. HasCallStack => input -> Eff (providedEs ++ es) r -> Eff es (f r)) -> Eff (ProviderList providedEs input f : es) a -> Eff es a
runProviderList_ :: forall providedEs input es a. (HasCallStack, KnownSubset providedEs (providedEs ++ es)) => (forall r. HasCallStack => input -> Eff (providedEs ++ es) r -> Eff es r) -> Eff (ProviderList_ providedEs input : es) a -> Eff es a
provideList :: forall providedEs f es a. (HasCallStack, ProviderList providedEs () f :> es) => Eff (providedEs ++ es) a -> Eff es (f a)
provideList_ :: forall providedEs es a. (HasCallStack, ProviderList_ providedEs () :> es) => Eff (providedEs ++ es) a -> Eff es a
provideListWith :: forall providedEs input f es a. (HasCallStack, ProviderList providedEs input f :> es) => input -> Eff (providedEs ++ es) a -> Eff es (f a)
provideListWith_ :: forall providedEs input es a. (HasCallStack, ProviderList_ providedEs input :> es) => input -> Eff (providedEs ++ es) a -> Eff es a
type family (xs :: [Effect]) ++ (ys :: [Effect]) :: [Effect] where ...
class Subset subEs es => KnownSubset (subEs :: [Effect]) (es :: [Effect])

Effect

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

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 :: forall providedEs input f es a. input -> Eff (providedEs ++ es) a -> ProviderList providedEs input f (Eff es) (f a)

Run the effect handlers with a given input.

Since: 2.7.0.0

Instances

Instances details

type DispatchOf (ProviderList providedEs input f) Source #
Instance details Defined in Effectful.Provider.List type DispatchOf (ProviderList providedEs input f) = 'Dynamic

type ProviderList_ providedEs input = ProviderList providedEs input Identity Source #

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

Handlers

runProviderList Source #

Arguments

:: forall providedEs input f es a. (HasCallStack, KnownSubset providedEs (providedEs ++ es))
=> (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_ Source #

Arguments

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

Run the ProviderList 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) Source #

Run the handler.

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

Run the handler with unchanged return type.

provideListWith Source #

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_ Source #

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 Source #

Append two type-level lists together.

Equations

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

class Subset subEs es => KnownSubset (subEs :: [Effect]) (es :: [Effect]) Source #

Provide evidence that subEs is a known subset of es.

Instances

Instances details

KnownSubset ('[] :: [Effect]) es Source #
Instance details Defined in Effectful.Internal.Effect
(e :> es, KnownSubset subEs es) => KnownSubset (e ': subEs) es Source #
Instance details Defined in Effectful.Internal.Effect