cleff-0.2.1.0: Fast and concise extensible effects

Copyright	(c) 2021 Xy Ren
License	BSD3
Maintainer	xy.r@outlook.com
Stability	experimental
Portability	non-portable (GHC only)
Safe Haskell	Trustworthy
Language	Haskell2010

Cleff.Fresh

Contents

Effect
Operations
Interpretations

Description

Synopsis

data Fresh u :: Effect where
- Fresh :: Fresh u m u
fresh :: Fresh u :> es => Eff es u
freshIntToState :: Eff (Fresh Int ': es) ~> Eff (State Int ': es)
runFreshAtomicCounter :: Eff (Fresh Int ': es) ~> Eff es
runFreshUnique :: IOE :> es => Eff (Fresh Unique ': es) ~> Eff es

Effect

data Fresh u :: Effect where Source #

An effect capable of generating unique values. This effect can be useful in generating variable indices.

Constructors

Fresh :: Fresh u m u

Operations

fresh :: Fresh u :> es => Eff es u Source #

Interpretations

freshIntToState :: Eff (Fresh Int ': es) ~> Eff (State Int ': es) Source #

Interpret a Fresh Int effect in terms of State Int. This is a specialized version of freshEnumToState.

runFreshAtomicCounter :: Eff (Fresh Int ': es) ~> Eff es Source #

Interpret a Fresh Int effect in terms of a AtomicCounter. This is usually faster than runFreshUnique.

Since: 0.2.1.0

runFreshUnique :: IOE :> es => Eff (Fresh Unique ': es) ~> Eff es Source #

Interpret a Fresh Unique effect in terms of IO actions. This is slower than runFreshAtomicCounter, but it won't overflow on maxBound :: Int.