Network.Wai.Routing.Route

Documentation

data Routes a m b

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)

data Meta a

Data added to a route via attach is returned in this Meta record.

Constructors

Meta

Fields

routeMethod :: !Method

routePath :: !ByteString

routeMeta :: a

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

Run the Routes monad and return the handlers per path.

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

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

addRoute

Arguments

:: Monad m

=> Method

-> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

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

attach :: a -> Routes a m ()

Add some metadata to the last route.

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

Get back all attached metadata.

get

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

head

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

post

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

put

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

delete

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

trace

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

options

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

connect

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

patch

Arguments

:: Monad m

=> ByteString

path

-> (a -> m Response)

handler

-> Predicate RoutingReq Error a

Predicate

-> Routes b m ()

Specialisation of addRoute for a specific HTTP Method.

type Renderer = Error -> Maybe ByteString

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

renderer :: Renderer -> Routes a m ()

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