Copyright	(c) Justin Le 2015
License	MIT
Maintainer	justin@jle.im
Stability	unstable
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Control.Monad.Prompt.Class

Description

Provides a typeclass for Applicative and Monad types that give you the ability to, at any time, "prompt" with an a and get a b in response. The power of this instance is that each type gets to define its own way to deliver a response.

This library provides instances for PromptT from Control.Monad.Prompt and the monad transformers in transformers and mtl. Feel free to create your own instances too.

data Interactive a = Interactive ((String -> String) -> a)

-- at any time, ask with a string to get a string
instance MonadPrompt String String Interactive where
    prompt str = Interactive $ f -> f str

Synopsis

Documentation

class Applicative m => MonadPrompt a b m | m -> a b where #

An Applicative (and possibly Monad) where you can, at any time, "prompt" with an a and receive a b in response.

Instances include PromptT and any transformers monad transformer over another MonadPrompt.

Minimal complete definition

prompt | prompts

Methods

prompt :: a -> m b #

Prompt with an a for a b in the context of the type.

prompts :: (b -> c) -> a -> m c #

Prompt with an a for a b in the context of the type, and apply the given function to receive a c.

Instances

(Monad m, MonadPrompt a b m) => MonadPrompt a b (MaybeT m) #
Methods prompt :: a -> MaybeT m b # prompts :: (b -> c) -> a -> MaybeT m c #
(Monad m, MonadPrompt a b m, Monoid w) => MonadPrompt a b (WriterT w m) #
Methods prompt :: a -> WriterT w m b # prompts :: (b -> c) -> a -> WriterT w m c #
(Monad m, MonadPrompt a b m, Monoid w) => MonadPrompt a b (WriterT w m) #
Methods prompt :: a -> WriterT w m b # prompts :: (b -> c) -> a -> WriterT w m c #
(Monad m, MonadPrompt a b m) => MonadPrompt a b (StateT s m) #
Methods prompt :: a -> StateT s m b # prompts :: (b -> c) -> a -> StateT s m c #
(Monad m, MonadPrompt a b m) => MonadPrompt a b (StateT s m) #
Methods prompt :: a -> StateT s m b # prompts :: (b -> c) -> a -> StateT s m c #
(Monad m, MonadPrompt a b m) => MonadPrompt a b (ErrorT e m) #
Methods prompt :: a -> ErrorT e m b # prompts :: (b -> c) -> a -> ErrorT e m c #
(Monad m, MonadPrompt a b m) => MonadPrompt a b (ExceptT e m) #
Methods prompt :: a -> ExceptT e m b # prompts :: (b -> c) -> a -> ExceptT e m c #
(Monad m, MonadPrompt a b m) => MonadPrompt a b (ReaderT * r m) #
Methods prompt :: a -> ReaderT * r m b # prompts :: (b -> c) -> a -> ReaderT * r m c #
Applicative t => MonadPrompt a b (PromptT a b t) #
Methods prompt :: a -> PromptT a b t b # prompts :: (b -> c) -> a -> PromptT a b t c #
(Monad m, MonadPrompt a b m, Monoid w) => MonadPrompt a b (RWST r w s m) #
Methods prompt :: a -> RWST r w s m b # prompts :: (b -> c) -> a -> RWST r w s m c #
(Monad m, MonadPrompt a b m, Monoid w) => MonadPrompt a b (RWST r w s m) #
Methods prompt :: a -> RWST r w s m b # prompts :: (b -> c) -> a -> RWST r w s m c #

prompt' :: MonadPrompt a b m => a -> m b #

A version of prompt strict on its prompting value.

prompts' :: MonadPrompt a b m => (b -> c) -> a -> m c #

A version of prompts strict on its prompting value.