Copyright	(c) 2023-2024 Sayo contributors
License	MPL-2.0 (see the file LICENSE)
Maintainer	ymdfield@outlook.jp
Safe Haskell	Safe-Inferred
Language	GHC2021

Data.Effect

Contents

Nop Effect
Embedding Effect
Reader Effects
State Effect
Writer Effects
Exception Effects
Non-Determinism Effects
Fail Effect
Fix Effect
Unlift Effect
CallCC Effect (Sub/Jump-based)

Description

Synopsis

type Effect = (Type -> Type) -> Type -> Type
data EffectOrder
- = FirstOrder
- | HigherOrder
type family OrderOf (e :: Effect) :: EffectOrder
type family OrderCase (e :: EffectOrder) a b where ...
type family LabelOf (e :: Effect)
class (OrderOf e ~ 'FirstOrder, forall f g a. Coercible (e f a) (e g a)) => FirstOrder (e :: Effect)
data Nop :: Effect
data NopLabel
newtype Emb e (f :: Type -> Type) (a :: Type) = Emb {
- getEmb :: e a
}
data EmbLabel (e :: Type -> Type)
newtype Unemb e a = Unemb {
- getUnemb :: forall f. e f a
}
data Ask r :: Effect where
- Ask :: Ask r f r
data AskLabel
data Local r :: Effect where
- Local :: (r -> r) -> f a -> Local r f a
data LocalLabel
data State s :: Effect where
- Get :: State s f s
- Put :: s -> State s f ()
data StateLabel
data Tell w :: Effect where
- Tell :: w -> Tell w f ()
data TellLabel
data WriterH w :: Effect where
- Listen :: f a -> WriterH w f (w, a)
- Censor :: (w -> w) -> f a -> WriterH w f a
data WriterHLabel
data Throw e :: Effect where
- Throw :: e -> Throw e f a
data ThrowLabel
data Catch e :: Effect where
- Catch :: f a -> (e -> f a) -> Catch e f a
data CatchLabel
data Empty :: Effect where
- Empty :: Empty f a
data EmptyLabel
data Choose :: Effect where
- Choose :: Choose f Bool
data ChooseLabel
data ChooseH :: Effect where
- ChooseH :: f a -> f a -> ChooseH f a
data ChooseHLabel
data Fail :: Effect where
- Fail :: String -> Fail f a
data FailLabel
data Fix :: Effect where
- Efix :: (a -> f a) -> Fix f a
data FixLabel
data UnliftBase b f (a :: Type) where
- WithRunInBase :: ((forall x. f x -> b x) -> b a) -> UnliftBase b f a
type UnliftIO = UnliftBase IO
data UnliftBaseLabel (b :: Type -> Type)
data CC ref :: Effect where
- SubFork :: CC ref f (Either (ref a) a)
- Jump :: ref a -> a -> CC ref f b
data CCLabel

Documentation

type Effect = (Type -> Type) -> Type -> Type Source #

The kind for effects.

data EffectOrder Source #

An order of effect.

Constructors

FirstOrder
HigherOrder

Instances

Instances details

Show EffectOrder Source #
Instance details Defined in Data.Effect Methods showsPrec :: Int -> EffectOrder -> ShowS # show :: EffectOrder -> String # showList :: [EffectOrder] -> ShowS #
Eq EffectOrder Source #
Instance details Defined in Data.Effect Methods (==) :: EffectOrder -> EffectOrder -> Bool # (/=) :: EffectOrder -> EffectOrder -> Bool #
Ord EffectOrder Source #
Instance details Defined in Data.Effect Methods compare :: EffectOrder -> EffectOrder -> Ordering # (<) :: EffectOrder -> EffectOrder -> Bool # (<=) :: EffectOrder -> EffectOrder -> Bool # (>) :: EffectOrder -> EffectOrder -> Bool # (>=) :: EffectOrder -> EffectOrder -> Bool # max :: EffectOrder -> EffectOrder -> EffectOrder # min :: EffectOrder -> EffectOrder -> EffectOrder #

type family OrderOf (e :: Effect) :: EffectOrder Source #

Instances

Instances details

type OrderOf Choose Source #
Instance details Defined in Data.Effect type OrderOf Choose = 'FirstOrder
type OrderOf ChooseH Source #
Instance details Defined in Data.Effect type OrderOf ChooseH = 'HigherOrder
type OrderOf Empty Source #
Instance details Defined in Data.Effect type OrderOf Empty = 'FirstOrder
type OrderOf Fail Source #
Instance details Defined in Data.Effect type OrderOf Fail = 'FirstOrder
type OrderOf Fix Source #
Instance details Defined in Data.Effect type OrderOf Fix = 'HigherOrder
type OrderOf Nop Source #
Instance details Defined in Data.Effect type OrderOf Nop = 'FirstOrder
type OrderOf (Ask r) Source #
Instance details Defined in Data.Effect type OrderOf (Ask r) = 'FirstOrder
type OrderOf (CC ref) Source #
Instance details Defined in Data.Effect type OrderOf (CC ref) = 'FirstOrder
type OrderOf (Catch w) Source #
Instance details Defined in Data.Effect type OrderOf (Catch w) = 'HigherOrder
type OrderOf (Emb e) Source #
Instance details Defined in Data.Effect type OrderOf (Emb e) = 'FirstOrder
type OrderOf (Local r) Source #
Instance details Defined in Data.Effect type OrderOf (Local r) = 'HigherOrder
type OrderOf (State s) Source #
Instance details Defined in Data.Effect type OrderOf (State s) = 'FirstOrder
type OrderOf (Tell w) Source #
Instance details Defined in Data.Effect type OrderOf (Tell w) = 'FirstOrder
type OrderOf (Throw e) Source #
Instance details Defined in Data.Effect type OrderOf (Throw e) = 'FirstOrder
type OrderOf (UnliftBase b) Source #
Instance details Defined in Data.Effect type OrderOf (UnliftBase b) = 'HigherOrder
type OrderOf (WriterH w) Source #
Instance details Defined in Data.Effect type OrderOf (WriterH w) = 'HigherOrder
type OrderOf (Union es) Source #
Instance details Defined in Data.Effect.OpenUnion type OrderOf (Union es) = 'HigherOrder
type OrderOf (HCont ff b) Source #
Instance details Defined in Data.Effect.HFunctor.HCont type OrderOf (HCont ff b) = 'HigherOrder
type OrderOf (Tagged tag e) Source #
Instance details Defined in Data.Effect.Tag type OrderOf (Tagged tag e) = OrderOf e

type family OrderCase (e :: EffectOrder) a b where ... Source #

Equations

OrderCase 'FirstOrder a b = a
OrderCase 'HigherOrder a b = b

type family LabelOf (e :: Effect) Source #

Instances

Instances details

type LabelOf Choose Source #
Instance details Defined in Data.Effect type LabelOf Choose = ChooseLabel
type LabelOf ChooseH Source #
Instance details Defined in Data.Effect type LabelOf ChooseH = ChooseHLabel
type LabelOf Empty Source #
Instance details Defined in Data.Effect type LabelOf Empty = EmptyLabel
type LabelOf Fail Source #
Instance details Defined in Data.Effect type LabelOf Fail = FailLabel
type LabelOf Fix Source #
Instance details Defined in Data.Effect type LabelOf Fix = FixLabel
type LabelOf Nop Source #
Instance details Defined in Data.Effect type LabelOf Nop = NopLabel
type LabelOf (Ask r) Source #
Instance details Defined in Data.Effect type LabelOf (Ask r) = AskLabel
type LabelOf (CC ref) Source #
Instance details Defined in Data.Effect type LabelOf (CC ref) = CCLabel
type LabelOf (Catch w) Source #
Instance details Defined in Data.Effect type LabelOf (Catch w) = CatchLabel
type LabelOf (Emb e) Source #
Instance details Defined in Data.Effect type LabelOf (Emb e) = EmbLabel e
type LabelOf (Local r) Source #
Instance details Defined in Data.Effect type LabelOf (Local r) = LocalLabel
type LabelOf (State s) Source #
Instance details Defined in Data.Effect type LabelOf (State s) = StateLabel
type LabelOf (Tell w) Source #
Instance details Defined in Data.Effect type LabelOf (Tell w) = TellLabel
type LabelOf (Throw e) Source #
Instance details Defined in Data.Effect type LabelOf (Throw e) = ThrowLabel
type LabelOf (UnliftBase b) Source #
Instance details Defined in Data.Effect type LabelOf (UnliftBase b) = UnliftBaseLabel b
type LabelOf (WriterH w) Source #
Instance details Defined in Data.Effect type LabelOf (WriterH w) = WriterHLabel
type LabelOf (Tagged tag e) Source #
Instance details Defined in Data.Effect.Tag type LabelOf (Tagged tag e) = TaggedLabel tag (LabelOf e)

class (OrderOf e ~ 'FirstOrder, forall f g a. Coercible (e f a) (e g a)) => FirstOrder (e :: Effect) Source #

Instances

Instances details

FirstOrder Choose Source #
Instance details Defined in Data.Effect
FirstOrder Empty Source #
Instance details Defined in Data.Effect
FirstOrder Fail Source #
Instance details Defined in Data.Effect
FirstOrder Nop Source #
Instance details Defined in Data.Effect
FirstOrder (Ask r) Source #
Instance details Defined in Data.Effect
FirstOrder (CC ref) Source #
Instance details Defined in Data.Effect
FirstOrder (Emb e) Source #
Instance details Defined in Data.Effect
FirstOrder (State s) Source #
Instance details Defined in Data.Effect
FirstOrder (Tell w) Source #
Instance details Defined in Data.Effect
FirstOrder (Throw e) Source #
Instance details Defined in Data.Effect
FirstOrder e => FirstOrder (Tagged tag e) Source #
Instance details Defined in Data.Effect.Tag

Nop Effect

data Nop :: Effect Source #

A effect with no operations.

Instances

Instances details

FirstOrder Nop Source #
Instance details Defined in Data.Effect
HFunctor Nop Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Nop f a -> Nop g a Source #
type LabelOf Nop Source #
Instance details Defined in Data.Effect type LabelOf Nop = NopLabel
type OrderOf Nop Source #
Instance details Defined in Data.Effect type OrderOf Nop = 'FirstOrder

data NopLabel Source #

Embedding Effect

newtype Emb e (f :: Type -> Type) (a :: Type) Source #

Constructors

Emb
Fields getEmb :: e a

Instances

Instances details

FirstOrder (Emb e) Source #
Instance details Defined in Data.Effect
HFunctor (Emb e) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Emb e f a -> Emb e g a Source #
Foldable e => Foldable (Emb e f) Source #
Instance details Defined in Data.Effect Methods fold :: Monoid m => Emb e f m -> m # foldMap :: Monoid m => (a -> m) -> Emb e f a -> m # foldMap' :: Monoid m => (a -> m) -> Emb e f a -> m # foldr :: (a -> b -> b) -> b -> Emb e f a -> b # foldr' :: (a -> b -> b) -> b -> Emb e f a -> b # foldl :: (b -> a -> b) -> b -> Emb e f a -> b # foldl' :: (b -> a -> b) -> b -> Emb e f a -> b # foldr1 :: (a -> a -> a) -> Emb e f a -> a # foldl1 :: (a -> a -> a) -> Emb e f a -> a # toList :: Emb e f a -> [a] # null :: Emb e f a -> Bool # length :: Emb e f a -> Int # elem :: Eq a => a -> Emb e f a -> Bool # maximum :: Ord a => Emb e f a -> a # minimum :: Ord a => Emb e f a -> a # sum :: Num a => Emb e f a -> a # product :: Num a => Emb e f a -> a #
Traversable e => Traversable (Emb e f) Source #
Instance details Defined in Data.Effect Methods traverse :: Applicative f0 => (a -> f0 b) -> Emb e f a -> f0 (Emb e f b) # sequenceA :: Applicative f0 => Emb e f (f0 a) -> f0 (Emb e f a) # mapM :: Monad m => (a -> m b) -> Emb e f a -> m (Emb e f b) # sequence :: Monad m => Emb e f (m a) -> m (Emb e f a) #
Applicative e => Applicative (Emb e f) Source #
Instance details Defined in Data.Effect Methods pure :: a -> Emb e f a # (<>) :: Emb e f (a -> b) -> Emb e f a -> Emb e f b # liftA2 :: (a -> b -> c) -> Emb e f a -> Emb e f b -> Emb e f c # (>) :: Emb e f a -> Emb e f b -> Emb e f b # (<*) :: Emb e f a -> Emb e f b -> Emb e f a #
Functor e => Functor (Emb e f) Source #
Instance details Defined in Data.Effect Methods fmap :: (a -> b) -> Emb e f a -> Emb e f b # (<$) :: a -> Emb e f b -> Emb e f a #
Monad e => Monad (Emb e f) Source #
Instance details Defined in Data.Effect Methods (>>=) :: Emb e f a -> (a -> Emb e f b) -> Emb e f b # (>>) :: Emb e f a -> Emb e f b -> Emb e f b # return :: a -> Emb e f a #
type LabelOf (Emb e) Source #
Instance details Defined in Data.Effect type LabelOf (Emb e) = EmbLabel e
type OrderOf (Emb e) Source #
Instance details Defined in Data.Effect type OrderOf (Emb e) = 'FirstOrder

data EmbLabel (e :: Type -> Type) Source #

newtype Unemb e a Source #

Constructors

Unemb
Fields getUnemb :: forall f. e f a

Reader Effects

data Ask r :: Effect where Source #

An effect that holds a value of type r in the context (environment).

Constructors

Ask :: Ask r f r

Obtain a value from the environment.

Instances

Instances details

FirstOrder (Ask r) Source #
Instance details Defined in Data.Effect
HFunctor (Ask r) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Ask r f a -> Ask r g a Source #
type LabelOf (Ask r) Source #
Instance details Defined in Data.Effect type LabelOf (Ask r) = AskLabel
type OrderOf (Ask r) Source #
Instance details Defined in Data.Effect type OrderOf (Ask r) = 'FirstOrder

data AskLabel Source #

data Local r :: Effect where Source #

An effect that locally modifies the value held in the environment.

Constructors

Local	Locally modifies the value held in the environment.
Fields :: (r -> r) A function that transforms the original value to the modified value. -> f a The local scope where the modification is applied. -> Local r f a

Instances

Instances details

HFunctor (Local r) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Local r f a -> Local r g a Source #
type LabelOf (Local r) Source #
Instance details Defined in Data.Effect type LabelOf (Local r) = LocalLabel
type OrderOf (Local r) Source #
Instance details Defined in Data.Effect type OrderOf (Local r) = 'HigherOrder

data LocalLabel Source #

State Effect

data State s :: Effect where Source #

An effect for holding mutable state values in the context.

Constructors

Get :: State s f s	Retrieves the current state value from the context.
Put :: s -> State s f ()	Overwrites the state value in the context.

Instances

Instances details

FirstOrder (State s) Source #
Instance details Defined in Data.Effect
HFunctor (State s) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> State s f a -> State s g a Source #
type LabelOf (State s) Source #
Instance details Defined in Data.Effect type LabelOf (State s) = StateLabel
type OrderOf (State s) Source #
Instance details Defined in Data.Effect type OrderOf (State s) = 'FirstOrder

data StateLabel Source #

Writer Effects

data Tell w :: Effect where Source #

An effect that can accumulate values monoidally in a context.

Constructors

Tell :: w -> Tell w f ()

Accumulates new values to the cumulative value held in the context.

Instances

Instances details

FirstOrder (Tell w) Source #
Instance details Defined in Data.Effect
HFunctor (Tell w) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Tell w f a -> Tell w g a Source #
type LabelOf (Tell w) Source #
Instance details Defined in Data.Effect type LabelOf (Tell w) = TellLabel
type OrderOf (Tell w) Source #
Instance details Defined in Data.Effect type OrderOf (Tell w) = 'FirstOrder

data TellLabel Source #

data WriterH w :: Effect where Source #

An effect that performs local operations on accumulations in the context on a per-scope basis.

Constructors

Listen	Obtains the accumulated value in the scope and returns it together as a pair.
Fields :: f a The scope from which to obtain the accumulation. -> WriterH w f (w, a)
Censor	Modifies the accumulation in the scope based on the given function.
Fields :: (w -> w) A function for modifying the accumulated value. -> f a The scope where the modification is applied. -> WriterH w f a

Instances

Instances details

HFunctor (WriterH w) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> WriterH w f a -> WriterH w g a Source #
type LabelOf (WriterH w) Source #
Instance details Defined in Data.Effect type LabelOf (WriterH w) = WriterHLabel
type OrderOf (WriterH w) Source #
Instance details Defined in Data.Effect type OrderOf (WriterH w) = 'HigherOrder

data WriterHLabel Source #

Exception Effects

data Throw e :: Effect where Source #

An effect to escape from the normal control structure with an exception value of type e in the middle of a context.

Constructors

Throw :: e -> Throw e f a

Throws an exception; that is, escapes from the normal control structure with an exception value in the middle of a context.

Instances

Instances details

FirstOrder (Throw e) Source #
Instance details Defined in Data.Effect
HFunctor (Throw e) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Throw e f a -> Throw e g a Source #
type LabelOf (Throw e) Source #
Instance details Defined in Data.Effect type LabelOf (Throw e) = ThrowLabel
type OrderOf (Throw e) Source #
Instance details Defined in Data.Effect type OrderOf (Throw e) = 'FirstOrder

data ThrowLabel Source #

data Catch e :: Effect where Source #

An effect to catch exceptions.

Constructors

Catch	Catches exceptions within a scope and processes them according to the given exception handler.
Fields :: f a The scope in which to catch exceptions. -> (e -> f a) Exception handler. Defines the processing to perform when an exception is thrown within the scope. -> Catch e f a

Instances

Instances details

HFunctor (Catch w) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Catch w f a -> Catch w g a Source #
type LabelOf (Catch w) Source #
Instance details Defined in Data.Effect type LabelOf (Catch w) = CatchLabel
type OrderOf (Catch w) Source #
Instance details Defined in Data.Effect type OrderOf (Catch w) = 'HigherOrder

data CatchLabel Source #

Non-Determinism Effects

data Empty :: Effect where Source #

An effect that eliminates a branch by causing the current branch context of a non-deterministic computation to fail.

Constructors

Empty :: Empty f a

Eliminates a branch by causing the current branch context of a non-deterministic computation to fail.

Instances

Instances details

FirstOrder Empty Source #
Instance details Defined in Data.Effect
HFunctor Empty Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Empty f a -> Empty g a Source #
type LabelOf Empty Source #
Instance details Defined in Data.Effect type LabelOf Empty = EmptyLabel
type OrderOf Empty Source #
Instance details Defined in Data.Effect type OrderOf Empty = 'FirstOrder

data EmptyLabel Source #

data Choose :: Effect where Source #

An effect that splits the computation into two branches.

Constructors

Choose :: Choose f Bool

Splits the computation into two branches. As a result of executing choose, the world branches into one where False is returned and one where True is returned.

Instances

Instances details

FirstOrder Choose Source #
Instance details Defined in Data.Effect
HFunctor Choose Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Choose f a -> Choose g a Source #
type LabelOf Choose Source #
Instance details Defined in Data.Effect type LabelOf Choose = ChooseLabel
type OrderOf Choose Source #
Instance details Defined in Data.Effect type OrderOf Choose = 'FirstOrder

data ChooseLabel Source #

data ChooseH :: Effect where Source #

An effect that executes two branches as scopes. A higher-order version of the Choose effect.

Constructors

ChooseH :: f a -> f a -> ChooseH f a

Executes the given two scopes as branches. Even if one fails due to the empty operation, the whole does not fail as long as the other does not fail.

Instances

Instances details

HFunctor ChooseH Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> ChooseH f a -> ChooseH g a Source #
type LabelOf ChooseH Source #
Instance details Defined in Data.Effect type LabelOf ChooseH = ChooseHLabel
type OrderOf ChooseH Source #
Instance details Defined in Data.Effect type OrderOf ChooseH = 'HigherOrder

data ChooseHLabel Source #

Fail Effect

data Fail :: Effect where Source #

Constructors

Fail :: String -> Fail f a

Instances

Instances details

FirstOrder Fail Source #
Instance details Defined in Data.Effect
HFunctor Fail Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Fail f a -> Fail g a Source #
type LabelOf Fail Source #
Instance details Defined in Data.Effect type LabelOf Fail = FailLabel
type OrderOf Fail Source #
Instance details Defined in Data.Effect type OrderOf Fail = 'FirstOrder

data FailLabel Source #

Fix Effect

data Fix :: Effect where Source #

Constructors

Efix :: (a -> f a) -> Fix f a

Instances

Instances details

HFunctor Fix Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> Fix f a -> Fix g a Source #
type LabelOf Fix Source #
Instance details Defined in Data.Effect type LabelOf Fix = FixLabel
type OrderOf Fix Source #
Instance details Defined in Data.Effect type OrderOf Fix = 'HigherOrder

data FixLabel Source #

Unlift Effect

data UnliftBase b f (a :: Type) where Source #

Constructors

WithRunInBase :: ((forall x. f x -> b x) -> b a) -> UnliftBase b f a

Instances

Instances details

HFunctor (UnliftBase b) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> UnliftBase b f a -> UnliftBase b g a Source #
type LabelOf (UnliftBase b) Source #
Instance details Defined in Data.Effect type LabelOf (UnliftBase b) = UnliftBaseLabel b
type OrderOf (UnliftBase b) Source #
Instance details Defined in Data.Effect type OrderOf (UnliftBase b) = 'HigherOrder

type UnliftIO = UnliftBase IO Source #

data UnliftBaseLabel (b :: Type -> Type) Source #

CallCC Effect (Sub/Jump-based)

data CC ref :: Effect where Source #

Constructors

SubFork :: CC ref f (Either (ref a) a)
Jump :: ref a -> a -> CC ref f b

Instances

Instances details

FirstOrder (CC ref) Source #
Instance details Defined in Data.Effect
HFunctor (CC ref) Source #
Instance details Defined in Data.Effect Methods hfmap :: (forall x. f x -> g x) -> CC ref f a -> CC ref g a Source #
type LabelOf (CC ref) Source #
Instance details Defined in Data.Effect type LabelOf (CC ref) = CCLabel
type OrderOf (CC ref) Source #
Instance details Defined in Data.Effect type OrderOf (CC ref) = 'FirstOrder

data CCLabel Source #