Copyright | (c) Athan Clark 2015 |
---|---|
License | BSD-3 |
Maintainer | athan.clark@gmail.com |
Stability | experimental |
Portability | POSIX |
Safe Haskell | None |
Language | Haskell2010 |
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
- get :: (Monad m, Monoid r) => r -> VerbListenerT r m ()
- post :: (Monad m, Monoid r) => (ByteString -> r) -> VerbListenerT r m ()
- put :: (Monad m, Monoid r) => (ByteString -> r) -> VerbListenerT r m ()
- delete :: (Monad m, Monoid r) => r -> VerbListenerT r m ()
- type VerbMap r = HashMap Verb (Either r (ByteString -> r))
- type Verb = StdMethod
- newtype VerbListenerT r m a = VerbListenerT {
- runVerbListenerT :: StateT (VerbMap r) m a
- execVerbListenerT :: Monad m => VerbListenerT r m a -> m (VerbMap r)
- getVerbFromRequest :: Request -> Verb
- verbsToMiddleware :: MonadIO m => VerbListenerT (MiddlewareT m) m () -> MiddlewareT m
Combinators
post :: (Monad m, Monoid r) => (ByteString -> r) -> VerbListenerT r m () Source #
For simple POST
responses
put :: (Monad m, Monoid r) => (ByteString -> r) -> VerbListenerT r m () Source #
For simple PUT
responses
Types
type VerbMap r = HashMap Verb (Either r (ByteString -> r)) Source #
A map from an HTTP verb, to a result and uploading method.
Monad Transformer
newtype VerbListenerT r m a Source #
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
VerbListenerT | |
|
execVerbListenerT :: Monad m => VerbListenerT r m a -> m (VerbMap r) Source #
Utilities
getVerbFromRequest :: Request -> Verb Source #
Fetches the HTTP verb from the WAI Request
- defaults to GET.
verbsToMiddleware :: MonadIO m => VerbListenerT (MiddlewareT m) m () -> MiddlewareT m Source #