Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Wai.Routing.Route

Contents

Re-exports

Synopsis

data Routes a m b
type App m = RoutingReq -> Continue m -> m ResponseReceived
data Config = Config {
- notFoundResponse :: !Response
}
type Continue m = Response -> m ResponseReceived
data Meta a = Meta {
- routeMethod :: !Method
- routePath :: !ByteString
- routeMeta :: a
}
prepare :: Monad m => Routes a m b -> Tree (App m)
route :: Monad m => Tree (App m) -> Request -> Continue m -> m ResponseReceived
routeWith :: Monad m => Config -> Tree (App m) -> Request -> Continue m -> m ResponseReceived
continue :: Monad m => (a -> m Response) -> a -> Continue m -> m ResponseReceived
addRoute :: Monad m => Method -> ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
attach :: a -> Routes a m ()
examine :: Routes a m b -> [Meta a]
get :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
head :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
post :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
put :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
delete :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
trace :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
options :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
connect :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
patch :: Monad m => ByteString -> (a -> Continue m -> m ResponseReceived) -> Predicate RoutingReq Error a -> Routes b m ()
type Renderer = Error -> Maybe (ByteString, ResponseHeaders)
renderer :: Renderer -> Routes a m ()
data Tree a
toList :: Tree a -> [Payload a]
foldTree :: (Payload a -> b -> b) -> b -> Tree a -> b
mapTree :: (Payload a -> Payload b) -> Tree a -> Tree b
data Payload a
path :: Payload a -> ByteString
value :: Payload a -> a

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

Instances details

Applicative (Routes a m) Source #
Instance details Defined in Network.Wai.Routing.Route Methods pure :: a0 -> Routes a m a0 # (<>) :: Routes a m (a0 -> b) -> Routes a m a0 -> Routes a m b # liftA2 :: (a0 -> b -> c) -> Routes a m a0 -> Routes a m b -> Routes a m c # (>) :: Routes a m a0 -> Routes a m b -> Routes a m b # (<*) :: Routes a m a0 -> Routes a m b -> Routes a m a0 #
Functor (Routes a m) Source #
Instance details Defined in Network.Wai.Routing.Route Methods fmap :: (a0 -> b) -> Routes a m a0 -> Routes a m b # (<$) :: a0 -> Routes a m b -> Routes a m a0 #
Monad (Routes a m) Source #
Instance details Defined in Network.Wai.Routing.Route Methods (>>=) :: Routes a m a0 -> (a0 -> Routes a m b) -> Routes a m b # (>>) :: Routes a m a0 -> Routes a m b -> Routes a m b # return :: a0 -> Routes a m a0 #

type App m = RoutingReq -> Continue m -> m ResponseReceived Source #

Similar to a WAI Application but for RoutingReq and not specific to IO.

data Config Source #

Configuration to customize the route handler

Constructors

Config
Fields notFoundResponse :: !Response

Instances

Instances details

Default Config Source #
Instance details Defined in Network.Wai.Routing.Route Methods def :: Config Source #

type Continue m = Response -> m ResponseReceived Source #

The WAI 3.0 application continuation for arbitrary m instead of IO.

data Meta a Source #

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 -> Tree (App m) Source #

Run the Routes monad and return the handlers per path.

route :: Monad m => Tree (App m) -> Request -> Continue m -> m ResponseReceived Source #

Routes requests to handlers based on predicated route declarations. Note that route (prepare ...) behaves like a WAI Application generalised to arbitrary monads.

routeWith :: Monad m => Config -> Tree (App m) -> Request -> Continue m -> m ResponseReceived Source #

continue :: Monad m => (a -> m Response) -> a -> Continue m -> m ResponseReceived Source #

Prior to WAI 3.0 applications returned a plain Response. continue turns such a function into a corresponding CPS version. For example:

sitemap :: Monad m => Routes a m ()
sitemap = do
    get "/f/:foo" (continue f) $ capture "foo"
    get "/g/:foo" g            $ capture "foo"

f :: Monad m => Int -> m Response
f x = ...

g :: Monad m => Int -> Continue m -> m ResponseReceived
g x k = k $ ...

addRoute Source #

Arguments

:: Monad m
=> Method
-> ByteString	path
-> (a -> Continue m -> m ResponseReceived)	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.

A route handler is like a WAI Application but instead of Request the first parameter is the result-type of the associated Predicate evaluation. I.e. the handler is applied to the predicate's metadata value iff the predicate is true.

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

Add some metadata to the last route.

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

Get back all attached metadata.

get Source #

Arguments

:: Monad m
=> ByteString	path
-> (a -> Continue m -> m ResponseReceived)	handler
-> Predicate RoutingReq Error a	`Predicate`
-> Routes b m ()