Unbound.Generics.LocallyNameless.Fresh

Global freshness monad.

Documentation

class Monad m => Fresh m where

The Fresh type class governs monads which can generate new globally unique Names based on a given Name.

Methods

fresh :: Name a -> m (Name a)

Generate a new globally unique name based on the given one.

Instances

Fresh m => Fresh (MaybeT m)

Monad m => Fresh (FreshMT m)

Fresh m => Fresh (FFM m)

Fresh m => Fresh (ReaderT r m)

Fresh m => Fresh (StateT s m)

Fresh m => Fresh (StateT s m)

Fresh m => Fresh (ExceptT e m)

(Error e, Fresh m) => Fresh (ErrorT e m)

(Monoid w, Fresh m) => Fresh (WriterT w m)

(Monoid w, Fresh m) => Fresh (WriterT w m)

newtype FreshMT m a

The FreshM monad transformer. Keeps track of the lowest index still globally unused, and increments the index every time it is asked for a fresh name.

Constructors

FreshMT

Fields

unFreshMT :: StateT Integer m a

Instances

MonadTrans FreshMT

MonadError e m => MonadError e (FreshMT m)

MonadReader r m => MonadReader r (FreshMT m)

MonadState s m => MonadState s (FreshMT m)

MonadWriter w m => MonadWriter w (FreshMT m)

Monad m => Monad (FreshMT m)

Functor m => Functor (FreshMT m)

MonadFix m => MonadFix (FreshMT m)

Monad m => Applicative (FreshMT m)

MonadPlus m => Alternative (FreshMT m)

MonadPlus m => MonadPlus (FreshMT m)

MonadIO m => MonadIO (FreshMT m)

MonadCont m => MonadCont (FreshMT m)

Monad m => Fresh (FreshMT m)

runFreshMT :: Monad m => FreshMT m a -> m a

Run a FreshMT computation (with the global index starting at zero).

contFreshMT :: Monad m => FreshMT m a -> Integer -> m a

Run a FreshMT computation given a starting index for fresh name generation.

type FreshM = FreshMT Identity

A convenient monad which is an instance of Fresh. It keeps track of a global index used for generating fresh names, which is incremented every time fresh is called.

runFreshM :: FreshM a -> a

Run a FreshM computation (with the global index starting at zero).

contFreshM :: FreshM a -> Integer -> a

Run a FreshM computation given a starting index.