Copyright	(C) 2021 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Hedgehog.Core.Monad

Contents

Re-exports

Description

Monad for random generation of clash-core types.

Synopsis

data CoreGenT m a
runCoreGenT :: CoreGenT m a -> CoreGenConfig -> m a
data CoreGenConfig = CoreGenConfig {
- allowDataKinds :: Bool
- allowPolyKinds :: Bool
- allowRankNTypes :: Bool
- allowTypeFamilies :: Bool
- allowUndecidableInstances :: Bool
}
defaultConfig :: CoreGenConfig
canGenDataKinds :: forall m. Monad m => CoreGenT m Bool
canGenPolyKinds :: forall m. Monad m => CoreGenT m Bool
canGenRankNTypes :: forall m. Monad m => CoreGenT m Bool
canGenTypeFamilies :: forall m. Monad m => CoreGenT m Bool
canGenUndecidableInstances :: forall m. Monad m => CoreGenT m Bool
class Applicative f => Alternative (f :: Type -> Type) where
- empty :: f a
- (<|>) :: f a -> f a -> f a
- some :: f a -> f [a]
- many :: f a -> f [a]
class (Monad m, Monad (GenBase m)) => MonadGen (m :: Type -> Type) where
- type GenBase (m :: Type -> Type) :: Type -> Type
- toGenT :: m a -> GenT (GenBase m) a
- fromGenT :: GenT (GenBase m) a -> m a
class Monad m => MonadReader r (m :: Type -> Type) | m -> r where
- ask :: m r
- local :: (r -> r) -> m a -> m a
- reader :: (r -> a) -> m a

Documentation

data CoreGenT m a Source #

The CoreGenT monad keeps track of features like language extensions which have an impact on what can be generated. This allows more meaningful random generation, as the output of generators can be constrained to the same variant of Haskell / Clash used by the caller.

Instances

Instances details

MonadTrans CoreGenT Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods lift :: Monad m => m a -> CoreGenT m a #
Monad m => MonadReader CoreGenConfig (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods ask :: CoreGenT m CoreGenConfig # local :: (CoreGenConfig -> CoreGenConfig) -> CoreGenT m a -> CoreGenT m a # reader :: (CoreGenConfig -> a) -> CoreGenT m a #
Monad m => Monad (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods (>>=) :: CoreGenT m a -> (a -> CoreGenT m b) -> CoreGenT m b # (>>) :: CoreGenT m a -> CoreGenT m b -> CoreGenT m b # return :: a -> CoreGenT m a #
Functor m => Functor (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods fmap :: (a -> b) -> CoreGenT m a -> CoreGenT m b # (<$) :: a -> CoreGenT m b -> CoreGenT m a #
MonadFail m => MonadFail (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods fail :: String -> CoreGenT m a #
Applicative m => Applicative (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods pure :: a -> CoreGenT m a # (<>) :: CoreGenT m (a -> b) -> CoreGenT m a -> CoreGenT m b # liftA2 :: (a -> b -> c) -> CoreGenT m a -> CoreGenT m b -> CoreGenT m c # (>) :: CoreGenT m a -> CoreGenT m b -> CoreGenT m b # (<*) :: CoreGenT m a -> CoreGenT m b -> CoreGenT m a #
Alternative m => Alternative (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods empty :: CoreGenT m a # (<\|>) :: CoreGenT m a -> CoreGenT m a -> CoreGenT m a # some :: CoreGenT m a -> CoreGenT m [a] # many :: CoreGenT m a -> CoreGenT m [a] #
MonadIO m => MonadIO (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods liftIO :: IO a -> CoreGenT m a #
MonadGen m => MonadGen (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Associated Types type GenBase (CoreGenT m) :: Type -> Type # Methods toGenT :: CoreGenT m a -> GenT (GenBase (CoreGenT m)) a # fromGenT :: GenT (GenBase (CoreGenT m)) a -> CoreGenT m a #
type GenBase (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad type GenBase (CoreGenT m) = GenBase (ReaderT CoreGenConfig m)

runCoreGenT :: CoreGenT m a -> CoreGenConfig -> m a Source #

Run a generator that generates types from clash-lib. This is intended to transform another monad which implements MonadGen.

data CoreGenConfig Source #

The configuration of Haskell / Clash which the generated source adheres to. These are typically things which change what a user could potentially have written in a source file, such as language extensions.

Constructors

CoreGenConfig
Fields allowDataKinds :: Bool allowPolyKinds :: Bool allowRankNTypes :: Bool allowTypeFamilies :: Bool allowUndecidableInstances :: Bool

Instances

Instances details

Show CoreGenConfig Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods showsPrec :: Int -> CoreGenConfig -> ShowS # show :: CoreGenConfig -> String # showList :: [CoreGenConfig] -> ShowS #
Monad m => MonadReader CoreGenConfig (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods ask :: CoreGenT m CoreGenConfig # local :: (CoreGenConfig -> CoreGenConfig) -> CoreGenT m a -> CoreGenT m a # reader :: (CoreGenConfig -> a) -> CoreGenT m a #

defaultConfig :: CoreGenConfig Source #

The default configuration matches the set of language extensions which are enabled by default when running clash / clashi. For most projects, this will likely be the most representative set of options.

canGenDataKinds :: forall m. Monad m => CoreGenT m Bool Source #

canGenPolyKinds :: forall m. Monad m => CoreGenT m Bool Source #

canGenRankNTypes :: forall m. Monad m => CoreGenT m Bool Source #

canGenTypeFamilies :: forall m. Monad m => CoreGenT m Bool Source #

canGenUndecidableInstances :: forall m. Monad m => CoreGenT m Bool Source #

Re-exports

class Applicative f => Alternative (f :: Type -> Type) where #

A monoid on applicative functors.

If defined, some and many should be the least solutions of the equations:

```
some v = (:) <$> v <*> many v
```
```
many v = some v <|> pure []
```

Minimal complete definition

empty, (<|>)

Methods

empty :: f a #

The identity of <|>

(<|>) :: f a -> f a -> f a infixl 3 #

An associative binary operation

some :: f a -> f [a] #

One or more.

many :: f a -> f [a] #

Zero or more.

Instances

Instances details

Alternative []	Since: base-2.1
Instance details Defined in GHC.Base Methods empty :: [a] # (<\|>) :: [a] -> [a] -> [a] # some :: [a] -> [[a]] # many :: [a] -> [[a]] #
Alternative Maybe	Since: base-2.1
Instance details Defined in GHC.Base Methods empty :: Maybe a # (<\|>) :: Maybe a -> Maybe a -> Maybe a # some :: Maybe a -> Maybe [a] # many :: Maybe a -> Maybe [a] #
Alternative IO	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods empty :: IO a # (<\|>) :: IO a -> IO a -> IO a # some :: IO a -> IO [a] # many :: IO a -> IO [a] #
Alternative IResult
Instance details Defined in Data.Aeson.Types.Internal Methods empty :: IResult a # (<\|>) :: IResult a -> IResult a -> IResult a # some :: IResult a -> IResult [a] # many :: IResult a -> IResult [a] #
Alternative Result
Instance details Defined in Data.Aeson.Types.Internal Methods empty :: Result a # (<\|>) :: Result a -> Result a -> Result a # some :: Result a -> Result [a] # many :: Result a -> Result [a] #
Alternative Parser
Instance details Defined in Data.Aeson.Types.Internal Methods empty :: Parser a # (<\|>) :: Parser a -> Parser a -> Parser a # some :: Parser a -> Parser [a] # many :: Parser a -> Parser [a] #
Alternative Option	Since: base-4.9.0.0
Instance details Defined in Data.Semigroup Methods empty :: Option a # (<\|>) :: Option a -> Option a -> Option a # some :: Option a -> Option [a] # many :: Option a -> Option [a] #
Alternative ZipList	Since: base-4.11.0.0
Instance details Defined in Control.Applicative Methods empty :: ZipList a # (<\|>) :: ZipList a -> ZipList a -> ZipList a # some :: ZipList a -> ZipList [a] # many :: ZipList a -> ZipList [a] #
Alternative ReadP	Since: base-4.6.0.0
Instance details Defined in Text.ParserCombinators.ReadP Methods empty :: ReadP a # (<\|>) :: ReadP a -> ReadP a -> ReadP a # some :: ReadP a -> ReadP [a] # many :: ReadP a -> ReadP [a] #
Alternative Seq	Since: containers-0.5.4
Instance details Defined in Data.Sequence.Internal Methods empty :: Seq a # (<\|>) :: Seq a -> Seq a -> Seq a # some :: Seq a -> Seq [a] # many :: Seq a -> Seq [a] #
Alternative DList
Instance details Defined in Data.DList.Internal Methods empty :: DList a # (<\|>) :: DList a -> DList a -> DList a # some :: DList a -> DList [a] # many :: DList a -> DList [a] #
Alternative Vector
Instance details Defined in Data.Vector Methods empty :: Vector a # (<\|>) :: Vector a -> Vector a -> Vector a # some :: Vector a -> Vector [a] # many :: Vector a -> Vector [a] #
Alternative SmallArray
Instance details Defined in Data.Primitive.SmallArray Methods empty :: SmallArray a # (<\|>) :: SmallArray a -> SmallArray a -> SmallArray a # some :: SmallArray a -> SmallArray [a] # many :: SmallArray a -> SmallArray [a] #
Alternative Array
Instance details Defined in Data.Primitive.Array Methods empty :: Array a # (<\|>) :: Array a -> Array a -> Array a # some :: Array a -> Array [a] # many :: Array a -> Array [a] #
Alternative P	Since: base-4.5.0.0
Instance details Defined in Text.ParserCombinators.ReadP Methods empty :: P a # (<\|>) :: P a -> P a -> P a # some :: P a -> P [a] # many :: P a -> P [a] #
Alternative (U1 :: Type -> Type)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods empty :: U1 a # (<\|>) :: U1 a -> U1 a -> U1 a # some :: U1 a -> U1 [a] # many :: U1 a -> U1 [a] #
Alternative (Parser i)
Instance details Defined in Data.Attoparsec.Internal.Types Methods empty :: Parser i a # (<\|>) :: Parser i a -> Parser i a -> Parser i a # some :: Parser i a -> Parser i [a] # many :: Parser i a -> Parser i [a] #
MonadPlus m => Alternative (WrappedMonad m)	Since: base-2.1
Instance details Defined in Control.Applicative Methods empty :: WrappedMonad m a # (<\|>) :: WrappedMonad m a -> WrappedMonad m a -> WrappedMonad m a # some :: WrappedMonad m a -> WrappedMonad m [a] # many :: WrappedMonad m a -> WrappedMonad m [a] #
ArrowPlus a => Alternative (ArrowMonad a)	Since: base-4.6.0.0
Instance details Defined in Control.Arrow Methods empty :: ArrowMonad a a0 # (<\|>) :: ArrowMonad a a0 -> ArrowMonad a a0 -> ArrowMonad a a0 # some :: ArrowMonad a a0 -> ArrowMonad a [a0] # many :: ArrowMonad a a0 -> ArrowMonad a [a0] #
(Functor m, Monad m) => Alternative (MaybeT m)
Instance details Defined in Control.Monad.Trans.Maybe Methods empty :: MaybeT m a # (<\|>) :: MaybeT m a -> MaybeT m a -> MaybeT m a # some :: MaybeT m a -> MaybeT m [a] # many :: MaybeT m a -> MaybeT m [a] #
Alternative m => Alternative (ResourceT m)	Since 1.1.5
Instance details Defined in Control.Monad.Trans.Resource.Internal Methods empty :: ResourceT m a # (<\|>) :: ResourceT m a -> ResourceT m a -> ResourceT m a # some :: ResourceT m a -> ResourceT m [a] # many :: ResourceT m a -> ResourceT m [a] #
Alternative v => Alternative (Free v)	This violates the Alternative laws, handle with care.
Instance details Defined in Control.Monad.Free Methods empty :: Free v a # (<\|>) :: Free v a -> Free v a -> Free v a # some :: Free v a -> Free v [a] # many :: Free v a -> Free v [a] #
MonadPlus m => Alternative (PropertyT m)
Instance details Defined in Hedgehog.Internal.Property Methods empty :: PropertyT m a # (<\|>) :: PropertyT m a -> PropertyT m a -> PropertyT m a # some :: PropertyT m a -> PropertyT m [a] # many :: PropertyT m a -> PropertyT m [a] #
Monad m => Alternative (GenT m)
Instance details Defined in Hedgehog.Internal.Gen Methods empty :: GenT m a # (<\|>) :: GenT m a -> GenT m a -> GenT m a # some :: GenT m a -> GenT m [a] # many :: GenT m a -> GenT m [a] #
Alternative m => Alternative (TreeT m)
Instance details Defined in Hedgehog.Internal.Tree Methods empty :: TreeT m a # (<\|>) :: TreeT m a -> TreeT m a -> TreeT m a # some :: TreeT m a -> TreeT m [a] # many :: TreeT m a -> TreeT m [a] #
Alternative f => Alternative (Yoneda f)
Instance details Defined in Data.Functor.Yoneda Methods empty :: Yoneda f a # (<\|>) :: Yoneda f a -> Yoneda f a -> Yoneda f a # some :: Yoneda f a -> Yoneda f [a] # many :: Yoneda f a -> Yoneda f [a] #
Alternative (ReifiedFold s)
Instance details Defined in Control.Lens.Reified Methods empty :: ReifiedFold s a # (<\|>) :: ReifiedFold s a -> ReifiedFold s a -> ReifiedFold s a # some :: ReifiedFold s a -> ReifiedFold s [a] # many :: ReifiedFold s a -> ReifiedFold s [a] #
Alternative m => Alternative (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods empty :: CoreGenT m a # (<\|>) :: CoreGenT m a -> CoreGenT m a -> CoreGenT m a # some :: CoreGenT m a -> CoreGenT m [a] # many :: CoreGenT m a -> CoreGenT m [a] #
Alternative f => Alternative (Rec1 f)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods empty :: Rec1 f a # (<\|>) :: Rec1 f a -> Rec1 f a -> Rec1 f a # some :: Rec1 f a -> Rec1 f [a] # many :: Rec1 f a -> Rec1 f [a] #
Alternative m => Alternative (Kleisli m a)	Since: base-4.14.0.0
Instance details Defined in Control.Arrow Methods empty :: Kleisli m a a0 # (<\|>) :: Kleisli m a a0 -> Kleisli m a a0 -> Kleisli m a a0 # some :: Kleisli m a a0 -> Kleisli m a [a0] # many :: Kleisli m a a0 -> Kleisli m a [a0] #
Alternative m => Alternative (ReaderT r m)
Instance details Defined in Control.Monad.Trans.Reader Methods empty :: ReaderT r m a # (<\|>) :: ReaderT r m a -> ReaderT r m a -> ReaderT r m a # some :: ReaderT r m a -> ReaderT r m [a] # many :: ReaderT r m a -> ReaderT r m [a] #
(ArrowZero a, ArrowPlus a) => Alternative (WrappedArrow a b)	Since: base-2.1
Instance details Defined in Control.Applicative Methods empty :: WrappedArrow a b a0 # (<\|>) :: WrappedArrow a b a0 -> WrappedArrow a b a0 -> WrappedArrow a b a0 # some :: WrappedArrow a b a0 -> WrappedArrow a b [a0] # many :: WrappedArrow a b a0 -> WrappedArrow a b [a0] #
Alternative f => Alternative (Ap f)	Since: base-4.12.0.0
Instance details Defined in Data.Monoid Methods empty :: Ap f a # (<\|>) :: Ap f a -> Ap f a -> Ap f a # some :: Ap f a -> Ap f [a] # many :: Ap f a -> Ap f [a] #
Alternative f => Alternative (Alt f)	Since: base-4.8.0.0
Instance details Defined in Data.Semigroup.Internal Methods empty :: Alt f a # (<\|>) :: Alt f a -> Alt f a -> Alt f a # some :: Alt f a -> Alt f [a] # many :: Alt f a -> Alt f [a] #
Alternative m => Alternative (IdentityT m)
Instance details Defined in Control.Monad.Trans.Identity Methods empty :: IdentityT m a # (<\|>) :: IdentityT m a -> IdentityT m a -> IdentityT m a # some :: IdentityT m a -> IdentityT m [a] # many :: IdentityT m a -> IdentityT m [a] #
(Monoid w, Alternative m) => Alternative (WriterT w m)
Instance details Defined in Control.Monad.Trans.Writer.Strict Methods empty :: WriterT w m a # (<\|>) :: WriterT w m a -> WriterT w m a -> WriterT w m a # some :: WriterT w m a -> WriterT w m [a] # many :: WriterT w m a -> WriterT w m [a] #
(Monoid w, Alternative m) => Alternative (WriterT w m)
Instance details Defined in Control.Monad.Trans.Writer.Lazy Methods empty :: WriterT w m a # (<\|>) :: WriterT w m a -> WriterT w m a -> WriterT w m a # some :: WriterT w m a -> WriterT w m [a] # many :: WriterT w m a -> WriterT w m [a] #
(Functor m, MonadPlus m) => Alternative (StateT s m)
Instance details Defined in Control.Monad.Trans.State.Strict Methods empty :: StateT s m a # (<\|>) :: StateT s m a -> StateT s m a -> StateT s m a # some :: StateT s m a -> StateT s m [a] # many :: StateT s m a -> StateT s m [a] #
(Functor m, MonadPlus m) => Alternative (StateT s m)
Instance details Defined in Control.Monad.Trans.State.Lazy Methods empty :: StateT s m a # (<\|>) :: StateT s m a -> StateT s m a -> StateT s m a # some :: StateT s m a -> StateT s m [a] # many :: StateT s m a -> StateT s m [a] #
(Functor m, Monad m, Monoid e) => Alternative (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods empty :: ExceptT e m a # (<\|>) :: ExceptT e m a -> ExceptT e m a -> ExceptT e m a # some :: ExceptT e m a -> ExceptT e m [a] # many :: ExceptT e m a -> ExceptT e m [a] #
(Functor f, MonadPlus m) => Alternative (FreeT f m)
Instance details Defined in Control.Monad.Trans.Free Methods empty :: FreeT f m a # (<\|>) :: FreeT f m a -> FreeT f m a -> FreeT f m a # some :: FreeT f m a -> FreeT f m [a] # many :: FreeT f m a -> FreeT f m [a] #
(Functor m, Monad m, Error e) => Alternative (ErrorT e m)
Instance details Defined in Control.Monad.Trans.Error Methods empty :: ErrorT e m a # (<\|>) :: ErrorT e m a -> ErrorT e m a -> ErrorT e m a # some :: ErrorT e m a -> ErrorT e m [a] # many :: ErrorT e m a -> ErrorT e m [a] #
(Alternative f, Alternative g) => Alternative (f :*: g)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods empty :: (f :: g) a # (<\|>) :: (f :: g) a -> (f :: g) a -> (f :: g) a # some :: (f :: g) a -> (f :: g) [a] # many :: (f :: g) a -> (f :: g) [a] #
(Alternative f, Alternative g) => Alternative (Product f g)	Since: base-4.9.0.0
Instance details Defined in Data.Functor.Product Methods empty :: Product f g a # (<\|>) :: Product f g a -> Product f g a -> Product f g a # some :: Product f g a -> Product f g [a] # many :: Product f g a -> Product f g [a] #
Alternative f => Alternative (M1 i c f)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods empty :: M1 i c f a # (<\|>) :: M1 i c f a -> M1 i c f a -> M1 i c f a # some :: M1 i c f a -> M1 i c f [a] # many :: M1 i c f a -> M1 i c f [a] #
(Alternative f, Applicative g) => Alternative (f :.: g)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods empty :: (f :.: g) a # (<\|>) :: (f :.: g) a -> (f :.: g) a -> (f :.: g) a # some :: (f :.: g) a -> (f :.: g) [a] # many :: (f :.: g) a -> (f :.: g) [a] #
(Alternative f, Applicative g) => Alternative (Compose f g)	Since: base-4.9.0.0
Instance details Defined in Data.Functor.Compose Methods empty :: Compose f g a # (<\|>) :: Compose f g a -> Compose f g a -> Compose f g a # some :: Compose f g a -> Compose f g [a] # many :: Compose f g a -> Compose f g [a] #

class (Monad m, Monad (GenBase m)) => MonadGen (m :: Type -> Type) where #

Class of monads which can generate input data for tests.

Associated Types

type GenBase (m :: Type -> Type) :: Type -> Type #

Methods

toGenT :: m a -> GenT (GenBase m) a #

Extract a GenT from a MonadGen.

fromGenT :: GenT (GenBase m) a -> m a #

Lift a GenT in to a MonadGen.

Instances

Instances details

MonadGen m => MonadGen (MaybeT m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (MaybeT m) :: Type -> Type # Methods toGenT :: MaybeT m a -> GenT (GenBase (MaybeT m)) a # fromGenT :: GenT (GenBase (MaybeT m)) a -> MaybeT m a #
Monad m => MonadGen (GenT m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (GenT m) :: Type -> Type # Methods toGenT :: GenT m a -> GenT (GenBase (GenT m)) a # fromGenT :: GenT (GenBase (GenT m)) a -> GenT m a #
MonadGen m => MonadGen (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Associated Types type GenBase (CoreGenT m) :: Type -> Type # Methods toGenT :: CoreGenT m a -> GenT (GenBase (CoreGenT m)) a # fromGenT :: GenT (GenBase (CoreGenT m)) a -> CoreGenT m a #
MonadGen m => MonadGen (ReaderT r m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (ReaderT r m) :: Type -> Type # Methods toGenT :: ReaderT r m a -> GenT (GenBase (ReaderT r m)) a # fromGenT :: GenT (GenBase (ReaderT r m)) a -> ReaderT r m a #
MonadGen m => MonadGen (IdentityT m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (IdentityT m) :: Type -> Type # Methods toGenT :: IdentityT m a -> GenT (GenBase (IdentityT m)) a # fromGenT :: GenT (GenBase (IdentityT m)) a -> IdentityT m a #
(MonadGen m, Monoid w) => MonadGen (WriterT w m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (WriterT w m) :: Type -> Type # Methods toGenT :: WriterT w m a -> GenT (GenBase (WriterT w m)) a # fromGenT :: GenT (GenBase (WriterT w m)) a -> WriterT w m a #
(MonadGen m, Monoid w) => MonadGen (WriterT w m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (WriterT w m) :: Type -> Type # Methods toGenT :: WriterT w m a -> GenT (GenBase (WriterT w m)) a # fromGenT :: GenT (GenBase (WriterT w m)) a -> WriterT w m a #
MonadGen m => MonadGen (StateT r m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (StateT r m) :: Type -> Type # Methods toGenT :: StateT r m a -> GenT (GenBase (StateT r m)) a # fromGenT :: GenT (GenBase (StateT r m)) a -> StateT r m a #
MonadGen m => MonadGen (StateT r m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (StateT r m) :: Type -> Type # Methods toGenT :: StateT r m a -> GenT (GenBase (StateT r m)) a # fromGenT :: GenT (GenBase (StateT r m)) a -> StateT r m a #
MonadGen m => MonadGen (ExceptT x m)
Instance details Defined in Hedgehog.Internal.Gen Associated Types type GenBase (ExceptT x m) :: Type -> Type # Methods toGenT :: ExceptT x m a -> GenT (GenBase (ExceptT x m)) a # fromGenT :: GenT (GenBase (ExceptT x m)) a -> ExceptT x m a #

class Monad m => MonadReader r (m :: Type -> Type) | m -> r where #

See examples in Control.Monad.Reader. Note, the partially applied function type (->) r is a simple reader monad. See the instance declaration below.

Minimal complete definition

(ask | reader), local

Methods

ask :: m r #

Retrieves the monad environment.

local #

Arguments

:: (r -> r)	The function to modify the environment.
-> m a	`Reader` to run in the modified environment.
-> m a

Executes a computation in a modified environment.

reader #

Arguments

:: (r -> a)	The selector function to apply to the environment.
-> m a

Retrieves a function of the current environment.

Instances

Instances details

MonadReader r m => MonadReader r (MaybeT m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: MaybeT m r # local :: (r -> r) -> MaybeT m a -> MaybeT m a # reader :: (r -> a) -> MaybeT m a #
MonadReader r m => MonadReader r (ListT m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: ListT m r # local :: (r -> r) -> ListT m a -> ListT m a # reader :: (r -> a) -> ListT m a #
MonadReader r m => MonadReader r (ResourceT m)
Instance details Defined in Control.Monad.Trans.Resource.Internal Methods ask :: ResourceT m r # local :: (r -> r) -> ResourceT m a -> ResourceT m a # reader :: (r -> a) -> ResourceT m a #
MonadReader r m => MonadReader r (TreeT m)
Instance details Defined in Hedgehog.Internal.Tree Methods ask :: TreeT m r # local :: (r -> r) -> TreeT m a -> TreeT m a # reader :: (r -> a) -> TreeT m a #
MonadReader r m => MonadReader r (TestT m)
Instance details Defined in Hedgehog.Internal.Property Methods ask :: TestT m r # local :: (r -> r) -> TestT m a -> TestT m a # reader :: (r -> a) -> TestT m a #
MonadReader r m => MonadReader r (PropertyT m)
Instance details Defined in Hedgehog.Internal.Property Methods ask :: PropertyT m r # local :: (r -> r) -> PropertyT m a -> PropertyT m a # reader :: (r -> a) -> PropertyT m a #
MonadReader r m => MonadReader r (GenT m)
Instance details Defined in Hedgehog.Internal.Gen Methods ask :: GenT m r # local :: (r -> r) -> GenT m a -> GenT m a # reader :: (r -> a) -> GenT m a #
MonadReader s (ReifiedGetter s)
Instance details Defined in Control.Lens.Reified Methods ask :: ReifiedGetter s s # local :: (s -> s) -> ReifiedGetter s a -> ReifiedGetter s a # reader :: (s -> a) -> ReifiedGetter s a #
MonadReader s (ReifiedFold s)
Instance details Defined in Control.Lens.Reified Methods ask :: ReifiedFold s s # local :: (s -> s) -> ReifiedFold s a -> ReifiedFold s a # reader :: (s -> a) -> ReifiedFold s a #
MonadReader e m => MonadReader e (Free m)
Instance details Defined in Control.Monad.Free Methods ask :: Free m e # local :: (e -> e) -> Free m a -> Free m a # reader :: (e -> a) -> Free m a #
(Representable f, Rep f ~ a) => MonadReader a (Co f)
Instance details Defined in Data.Functor.Rep Methods ask :: Co f a # local :: (a -> a) -> Co f a0 -> Co f a0 # reader :: (a -> a0) -> Co f a0 #
Monad m => MonadReader CoreGenConfig (CoreGenT m) Source #
Instance details Defined in Clash.Hedgehog.Core.Monad Methods ask :: CoreGenT m CoreGenConfig # local :: (CoreGenConfig -> CoreGenConfig) -> CoreGenT m a -> CoreGenT m a # reader :: (CoreGenConfig -> a) -> CoreGenT m a #
Monad m => MonadReader r (ReaderT r m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: ReaderT r m r # local :: (r -> r) -> ReaderT r m a -> ReaderT r m a # reader :: (r -> a) -> ReaderT r m a #
(Monoid w, MonadReader r m) => MonadReader r (WriterT w m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: WriterT w m r # local :: (r -> r) -> WriterT w m a -> WriterT w m a # reader :: (r -> a) -> WriterT w m a #
(Monoid w, MonadReader r m) => MonadReader r (WriterT w m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: WriterT w m r # local :: (r -> r) -> WriterT w m a -> WriterT w m a # reader :: (r -> a) -> WriterT w m a #
MonadReader r m => MonadReader r (StateT s m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: StateT s m r # local :: (r -> r) -> StateT s m a -> StateT s m a # reader :: (r -> a) -> StateT s m a #
MonadReader r m => MonadReader r (StateT s m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: StateT s m r # local :: (r -> r) -> StateT s m a -> StateT s m a # reader :: (r -> a) -> StateT s m a #
MonadReader r m => MonadReader r (IdentityT m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: IdentityT m r # local :: (r -> r) -> IdentityT m a -> IdentityT m a # reader :: (r -> a) -> IdentityT m a #
MonadReader r m => MonadReader r (ExceptT e m)	Since: mtl-2.2
Instance details Defined in Control.Monad.Reader.Class Methods ask :: ExceptT e m r # local :: (r -> r) -> ExceptT e m a -> ExceptT e m a # reader :: (r -> a) -> ExceptT e m a #
(Error e, MonadReader r m) => MonadReader r (ErrorT e m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: ErrorT e m r # local :: (r -> r) -> ErrorT e m a -> ErrorT e m a # reader :: (r -> a) -> ErrorT e m a #
(Functor f, MonadReader r m) => MonadReader r (FreeT f m)
Instance details Defined in Control.Monad.Trans.Free Methods ask :: FreeT f m r # local :: (r -> r) -> FreeT f m a -> FreeT f m a # reader :: (r -> a) -> FreeT f m a #
MonadReader r m => MonadReader r (ConduitT i o m)
Instance details Defined in Data.Conduit.Internal.Conduit Methods ask :: ConduitT i o m r # local :: (r -> r) -> ConduitT i o m a -> ConduitT i o m a # reader :: (r -> a) -> ConduitT i o m a #
MonadReader r ((->) r :: Type -> Type)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: r -> r # local :: (r -> r) -> (r -> a) -> r -> a # reader :: (r -> a) -> r -> a #
MonadReader r' m => MonadReader r' (ContT r m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: ContT r m r' # local :: (r' -> r') -> ContT r m a -> ContT r m a # reader :: (r' -> a) -> ContT r m a #
(Monad m, Monoid w) => MonadReader r (RWST r w s m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: RWST r w s m r # local :: (r -> r) -> RWST r w s m a -> RWST r w s m a # reader :: (r -> a) -> RWST r w s m a #
(Monad m, Monoid w) => MonadReader r (RWST r w s m)
Instance details Defined in Control.Monad.Reader.Class Methods ask :: RWST r w s m r # local :: (r -> r) -> RWST r w s m a -> RWST r w s m a # reader :: (r -> a) -> RWST r w s m a #
MonadReader r m => MonadReader r (Pipe l i o u m)
Instance details Defined in Data.Conduit.Internal.Pipe Methods ask :: Pipe l i o u m r # local :: (r -> r) -> Pipe l i o u m a -> Pipe l i o u m a # reader :: (r -> a) -> Pipe l i o u m a #