Network.Wai.Middleware.Verbs

This module provides everything you need to respond depending on an HTTP verbs. The Combinators section defines the get, post and other functions you would expect in a toolset like this. The VerbListenerT object is constructed from the combinators, and turning it directly into a WAI MiddlewareT is easy with verbsToMiddleware.

myApp :: MonadIO => MiddlewareT m
myApp = verbsToMiddleware $ do
  get myMiddleware1
  put uploader myMiddleware2
  post uploader myMiddleware3
  delete myMiddleware4
  where
    uploader :: MonadIO m => Request -> m ()
    uploader req = liftIO $ print =<< getStrictRequestBody req

Combinators

get :: Monad m => r -> VerbListenerT r m ()

For simple GET responses

post :: Monad m => (Request -> m ()) -> r -> VerbListenerT r m ()

For simple POST responses

put :: Monad m => (Request -> m ()) -> r -> VerbListenerT r m ()

For simple PUT responses

delete :: Monad m => r -> VerbListenerT r m ()

For simple DELETE responses

Types

type VerbMap m r = HashMap Verb (Request -> m (), r)

A map from an HTTP verb, to a result and uploading method.

type Verb = StdMethod

Monad Transformer

newtype VerbListenerT r m a

This is the monad for our DSL - where r is the result type. We leave this polymorphic for ActionT for nested-routes.

myListener :: MonadIO m => VerbListenerT (MiddlewareT m) m ()
myListener = do
  get myMiddleware1
  post uploader myMiddleware2
  where
    uploader :: MonadIO Request -> m ()
    uploader req =
      liftIO $ print =<< strictRequestBody req

Constructors

VerbListenerT

Fields

runVerbListenerT :: StateT (VerbMap m r) m a

Instances

MonadReader r m => MonadReader r (VerbListenerT r m)

MonadWriter w m => MonadWriter w (VerbListenerT r m)

MonadBase b m => MonadBase b (VerbListenerT r m)

MonadError e' m => MonadError e' (VerbListenerT r m)

MonadTrans (VerbListenerT r)

Monad m => Monad (VerbListenerT r m)

Functor m => Functor (VerbListenerT r m)

MonadFix m => MonadFix (VerbListenerT r m)

Monad m => Applicative (VerbListenerT r m)

MonadPlus m => Alternative (VerbListenerT r m)

MonadPlus m => MonadPlus (VerbListenerT r m)

MonadIO m => MonadIO (VerbListenerT r m)

MonadCont m => MonadCont (VerbListenerT r m)

MonadThrow m => MonadThrow (VerbListenerT r m)

MonadMask m => MonadMask (VerbListenerT r m)

MonadCatch m => MonadCatch (VerbListenerT r m)

(MonadResource m, MonadBase IO m) => MonadResource (VerbListenerT r m)

MonadLogger m => MonadLogger (VerbListenerT r m)

Monad m => MonadState (VerbMap m r) (VerbListenerT r m)

execVerbListenerT :: Monad m => VerbListenerT r m a -> m (VerbMap m r)

Utilities

lookupVerb :: Monad m => Request -> Verb -> VerbMap m r -> m (Maybe r)

Take the monadic partial result of lookupVerb, and actually h the upload.

getVerb :: Request -> Verb

Fetches the HTTP verb from the WAI Request - defaults to GET.

mapVerbs :: Monad m => (r -> s) -> VerbListenerT r m () -> VerbListenerT s m ()