wai-routing-0.3.1: Declarative routing for WAI.

Safe Haskell	None

Network.Wai.Routing.Route

Synopsis

Documentation

data Routes a m b Source

The Routes monad is used to add routing declarations via addRoute or one of get, post, etc.

Instances

Monad (Routes a m)
Functor (Routes a m)
Applicative (Routes a m)

type Renderer = Error -> Maybe ByteString Source

Function to turn an Error value into a ByteString. Clients can provide their own renderer using renderer.

route :: Monad m => [(ByteString, Req -> m Response)] -> Request -> m Response Source

A WAI Application (generalised from IO to Monad) which routes requests to handlers based on predicated route declarations.

prepare :: Monad m => Routes a m b -> [(ByteString, Req -> m Response)]Source

Run the Routes monad and return the handlers per path.

renderer :: Renderer -> Routes m a ()Source

Set a custom render function, i.e. a function to turn Errors into ByteStrings.

addRoute Source

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> Method
-> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Add a route for some Method and path (potentially with variable captures) and constrained by some Predicate.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

Arguments

:: (Monad m, Predicate p Req, FVal p ~ Error)
=> ByteString	path
-> (TVal p -> m Response)	handler
-> p	`Predicate`
-> Routes a m ()

Specialisation of addRoute for a specific HTTP Method.

attach :: a -> Routes a m ()Source

Add some metadata to the last route.

examine :: Routes a m b -> [a]Source

Get back all attached metadata.