Network.CGI.Monad

Internal stuff that most people shouldn't have to use. This module mostly deals with the internals of the CGIT monad transformer.

CGI monad class

class Monad m => MonadCGI m where

The class of CGI monads. Most CGI actions can be run in any monad which is an instance of this class, which means that you can use your own monad transformers to add extra functionality.

Methods

cgiAddHeader :: HeaderName -> String -> m ()

Add a response header.

cgiGet :: (CGIRequest -> a) -> m a

Get something from the CGI request.

Instances

Monad m => MonadCGI (CGIT m)

Defined in Network.CGI.Monad

Methods

cgiAddHeader :: HeaderName -> String -> CGIT m ()

cgiGet :: (CGIRequest -> a) -> CGIT m a

CGI monad transformer

newtype CGIT m a

The CGIT monad transformer.

Constructors

CGIT

Fields

• unCGIT :: ReaderT CGIRequest (WriterT Headers m) a

Instances

MonadTrans CGIT

Defined in Network.CGI.Monad

Methods

lift :: Monad m => m a -> CGIT m a

MonadCatch m => MonadError SomeException (CGIT m)

Defined in Network.CGI.Monad

Methods

throwError :: SomeException -> CGIT m a

catchError :: CGIT m a -> (SomeException -> CGIT m a) -> CGIT m a

Monad m => Monad (CGIT m)

Defined in Network.CGI.Monad

Methods

(>>=) :: CGIT m a -> (a -> CGIT m b) -> CGIT m b

(>>) :: CGIT m a -> CGIT m b -> CGIT m b

return :: a -> CGIT m a

fail :: String -> CGIT m a

Functor m => Functor (CGIT m)

Defined in Network.CGI.Monad

Methods

fmap :: (a -> b) -> CGIT m a -> CGIT m b

(<$) :: a -> CGIT m b -> CGIT m a

Applicative m => Applicative (CGIT m)

Defined in Network.CGI.Monad

Methods

pure :: a -> CGIT m a

(<*>) :: CGIT m (a -> b) -> CGIT m a -> CGIT m b

liftA2 :: (a -> b -> c) -> CGIT m a -> CGIT m b -> CGIT m c

(*>) :: CGIT m a -> CGIT m b -> CGIT m b

(<*) :: CGIT m a -> CGIT m b -> CGIT m a

MonadIO m => MonadIO (CGIT m)

Defined in Network.CGI.Monad

Methods

liftIO :: IO a -> CGIT m a

MonadThrow m => MonadThrow (CGIT m)

Defined in Network.CGI.Monad

Methods

throwM :: Exception e => e -> CGIT m a

MonadCatch m => MonadCatch (CGIT m)

Defined in Network.CGI.Monad

Methods

catch :: Exception e => CGIT m a -> (e -> CGIT m a) -> CGIT m a

MonadMask m => MonadMask (CGIT m)

Defined in Network.CGI.Monad

Methods

mask :: ((forall a. CGIT m a -> CGIT m a) -> CGIT m b) -> CGIT m b

uninterruptibleMask :: ((forall a. CGIT m a -> CGIT m a) -> CGIT m b) -> CGIT m b

generalBracket :: CGIT m a -> (a -> ExitCase b -> CGIT m c) -> (a -> CGIT m b) -> CGIT m (b, c)

Monad m => MonadCGI (CGIT m)

Defined in Network.CGI.Monad

Methods

cgiAddHeader :: HeaderName -> String -> CGIT m ()

cgiGet :: (CGIRequest -> a) -> CGIT m a

type CGI a = CGIT IO a

A simple CGI monad with just IO.

runCGIT :: Monad m => CGIT m a -> CGIRequest -> m (Headers, a)

Run a CGI action.

Request info

data CGIRequest

The input to a CGI action.

Constructors

CGIRequest

Fields

• cgiVars :: Map String String

  Environment variables.

• cgiInputs :: [(String, Input)]

  Input parameters. For better laziness in reading inputs, this is not a Map.

• cgiRequestBody :: ByteString

  Raw request body. To avoid memory leaks, this is the empty string if the request body has been interpreted as inputs in "application/x-www-form-urlencoded" or "multipart/form-data" format.

Instances

Show CGIRequest

Defined in Network.CGI.Protocol

Methods

showsPrec :: Int -> CGIRequest -> ShowS

show :: CGIRequest -> String

showList :: [CGIRequest] -> ShowS

Error handling

throwCGI :: MonadThrow m => SomeException -> m a

Deprecated: Use Control.Monad.Catch.throwM instead.

Deprecated alias for throwM. Please use throwM instead.

catchCGI :: MonadCatch m => m a -> (SomeException -> m a) -> m a

Deprecated: Use Control.Monad.Catch.catch instead.

Deprecated alias for catch. Please use catch instead.

tryCGI :: MonadCatch m => m a -> m (Either SomeException a)

Deprecated: Use Control.Monad.Catch.try instead.

Deprecated alias for try. Please use try instead.

handleExceptionCGI :: MonadCatch m => m a -> (SomeException -> m a) -> m a

Deprecated: Use Control.Monad.Catch.catch instead.

Deprecated alias for catch. Please use catch instead.