Network.Wai.Middleware.Routes

This package provides typesafe URLs for Wai applications.

Declaring Routes using Template Haskell

parseRoutes :: QuasiQuoter

A quasi-quoter to parse a string into a list of Resources. Checks for overlapping routes, failing if present; use parseRoutesNoCheck to skip the checking. See documentation site for details on syntax.

parseRoutesFile :: FilePath -> Q Exp

Parse routes declared in a file

parseRoutesNoCheck :: QuasiQuoter

Same as parseRoutes, but performs no overlap checking.

parseRoutesFileNoCheck :: FilePath -> Q Exp

Same as parseRoutesFile, but performs no overlap checking.

mkRoute :: String -> [ResourceTree String] -> Q [Dec]

Generates all the things needed for efficient routing. Including your application's Route datatype, RenderRoute, ParseRoute, RouteAttrs, and Routable instances. Use this for everything except subsites

mkRouteSub :: String -> String -> [ResourceTree String] -> Q [Dec]

Same as mkRoute, but for subsites

Dispatch

routeDispatch :: Routable master master => master -> Middleware

Generates the application middleware from a Routable master datatype

URL rendering and parsing

showRoute :: RenderRoute master => Route master -> Text

Renders a Route as Text

showRouteQuery :: RenderRoute master => Route master -> [(Text, Text)] -> Text

Render a Route and Query parameters to Text

readRoute :: ParseRoute master => Text -> Maybe (Route master)

Read a route from Text Returns Nothing if Route reading failed. Just route otherwise

showRouteMaster :: RenderRoute master => HandlerM sub master (Route master -> Text)

Get the route rendering function for the master site

showRouteQueryMaster :: RenderRoute master => HandlerM sub master (Route master -> [(Text, Text)] -> Text)

Get the route rendering function for the master site

readRouteMaster :: ParseRoute master => HandlerM sub master (Text -> Maybe (Route master))

Get the route parsing function for the master site

showRouteSub :: RenderRoute master => HandlerM sub master (Route sub -> Text)

Get the route rendering function for the subsite

showRouteQuerySub :: RenderRoute master => HandlerM sub master (Route sub -> [(Text, Text)] -> Text)

Get the route rendering function for the subsite

readRouteSub :: ParseRoute sub => HandlerM sub master (Text -> Maybe (Route master))

Get the route parsing function for the subsite

Application Handlers

type Handler sub = forall master. RenderRoute master => HandlerS sub master

A Handler generates an App from the master datatype

type HandlerS sub master = Env sub master -> App sub

Generated Datatypes

class Routable sub master where

A Routable instance can be used in dispatching. An appropriate instance for your site datatype is automatically generated by mkRoute.

Methods

dispatcher :: HandlerS sub master

Used internally. However needs to be exported for TH to work.

class Eq (Route a) => RenderRoute a where

Associated Types

data Route a

The type-safe URLs associated with a site argument.

Methods

renderRoute

Arguments

:: Route a

-> ([Text], [(Text, Text)])

The path of the URL split on forward slashes, and a list of query parameters with their associated value.

Instances

RenderRoute DefaultMaster

A RenderRoute instance for your site datatype is automatically generated by mkRoute

class RenderRoute a => ParseRoute a where

Methods

parseRoute

Arguments

:: ([Text], [(Text, Text)])

The path of the URL split on forward slashes, and a list of query parameters with their associated value.

-> Maybe (Route a)

Instances

ParseRoute DefaultMaster

A ParseRoute instance for your site datatype is automatically generated by mkRoute

class RenderRoute a => RouteAttrs a where

Methods

routeAttrs

Arguments

:: Route a

-> Set Text

A set of attributes associated with the route.

Instances

RouteAttrs DefaultMaster

A RouteAttrs instance for your site datatype is automatically generated by mkRoute

Accessing Raw Request Data

data RequestData master

An abstract representation of the request data. You can get the wai request object by using waiReq

waiReq :: RequestData master -> Request

Extract the wai Request object from RequestData

nextApp :: RequestData master -> Application

Extract the next Application in the stack

runNext :: App master

Run the next application in the stack

Run the next application in the stack

Route Monad makes it easy to compose routes together

type RouteM = F RouterF

data DefaultMaster

Constructors

DefaultMaster

Instances

Eq DefaultMaster

Ord DefaultMaster

Show DefaultMaster

RouteAttrs DefaultMaster

ParseRoute DefaultMaster

RenderRoute DefaultMaster

Eq (Route DefaultMaster)

Ord (Route DefaultMaster)

Show (Route DefaultMaster)

data Route DefaultMaster = DefaultRoute ([Text], [(Text, Text)])

handler :: HandlerS DefaultMaster DefaultMaster -> RouteM ()

Add a wai-routes handler

Add a wai-routes handler

catchall :: Application -> RouteM ()

Catch all routes and process them with the supplied application. Note: As expected from the name, no request proceeds past a catchall.

Catch all routes with the supplied application

defaultAction :: Application -> RouteM ()

Synonym of catchall. Kept for backwards compatibility

A synonym for catchall, kept for backwards compatibility

middleware :: Middleware -> RouteM ()

Add a middleware to the application Middleware are ordered so the one declared earlier wraps the ones later

Add another middleware to the app

route :: Routable master master => master -> RouteM ()

Add a route to the application. Routes are ordered so the one declared earlier is matched first.

Add another routed middleware to the app

waiApp :: RouteM () -> Application

Convert a RouteM monad into a wai application. Note: We ignore the return type of the monad

Convert a RouteM to a wai Application

toWaiApp :: Monad m => RouteM () -> m Application

Similar to waiApp but returns the app in an arbitrary monad Kept for backwards compatibility

Similar to waiApp, but result is wrapped in a monad. Kept for backwards compatibility

HandlerM Monad makes it easy to build a handler

type HandlerM sub master a = HandlerMI sub master IO a

The HandlerM Monad

runHandlerM :: HandlerM sub master () -> HandlerS sub master

Run HandlerM, resulting in a Handler

Run a HandlerM to get a Handler

mountedAppHandler :: Application -> HandlerS sub master

Convert a full wai application to a Handler A bit like subsites, but at a higher level.

Convert a full wai application to a HandlerS

request :: HandlerM sub master Request

Get the request

Access the request data

isWebsocket :: HandlerM sub master Bool

Is this a websocket request

Is this a websocket request

reqHeader :: Text -> HandlerM sub master (Maybe Text)

Get a particular request header (Case insensitive)

Get a particular request header (case insensitive)

reqHeaders :: HandlerM sub master RequestHeaders

Get all request headers as raw case-insensitive bytestrings

Get all request headers (case insensitive)

maybeRootRoute :: HandlerM sub master (Maybe (Route master))

Get the current root route

Access the current route for root route

maybeRoute :: HandlerM sub master (Maybe (Route sub))

Get the current route

Access the current route

routeAttrSet :: RouteAttrs sub => HandlerM sub master (Set Text)

Get the current route attributes

Access the current route attributes as a set

rootRouteAttrSet :: RouteAttrs master => HandlerM sub master (Set Text)

Get the attributes for the current root route

Access the current root route attributes as a set

master :: HandlerM sub master master

Get the master

Access the master datatype

sub :: HandlerM sub master sub

Get the sub

Access the sub datatype

rawBody :: HandlerM sub master ByteString

Get the request body as a bytestring. Consumes the entire body into memory at once. TODO: Implement streaming. Prevent clash with direct use of requestBody

Consume and return the request body as ByteString

textBody :: HandlerM master master Text

Get the request body as a Text. However consumes the entire body at once. TODO: Implement streaming. Prevent clash with direct use of requestBody

Consume and return the request body as Text

jsonBody :: FromJSON a => HandlerM sub master (Either String a)

Parse the body as a JSON object

Consume and return the request body as JSON

header :: HeaderName -> ByteString -> HandlerM sub master ()

Add a header to the application response TODO: Differentiate between setting and adding headers

Add a header to the response

status :: Status -> HandlerM sub master ()

Set the response status

Set the response status

file :: FilePath -> HandlerM sub master ()

Send a file as response

Send a file as response

filepart :: FilePath -> FilePart -> HandlerM sub master ()

Send a part of a file as response

Send a part of a file as response

stream :: StreamingBody -> HandlerM sub master ()

Stream the response

Stream a response

raw :: ByteString -> HandlerM sub master ()

Set the response body

Set the raw response body

rawBuilder :: Builder -> HandlerM sub master ()

Set the response body as a builder

Set the raw response body as a ByteString Builder

json :: ToJSON a => a -> HandlerM sub master ()

Set the body of the response to the JSON encoding of the given value. Also sets "Content-Type" header to "application/json".

Set the json response body

plain :: Text -> HandlerM sub master ()

Set the body of the response to the given Text value. Also sets "Content-Type" header to "text/plain".

Set the plain text response body

html :: Text -> HandlerM sub master ()

Set the body of the response to the given Text value. Also sets "Content-Type" header to "text/html".

Set the html response body

css :: Text -> HandlerM sub master ()

Set the body of the response to the given Text value. Also sets "Content-Type" header to "text/css".

Set the css response body

javascript :: Text -> HandlerM sub master ()

Set the body of the response to the given Text value. Also sets "Content-Type" header to "text/javascript".

Set the javascript response body

asContent :: ByteString -> Text -> HandlerM sub master ()

Sets the content-type header to the given Bytestring (look in Network.Wai.Middleware.Routes.ContentTypes for examples) And sets the body of the response to the given Text

Set the contentType and a Text body

next :: HandlerM sub master ()

Run the next application

Run the next application in the stack

getParams :: HandlerM sub master [(Text, Text)]

Get all params (query or post, NOT file) Duplicate parameters are preserved

Get all params (query or post, not file)

getParam :: Text -> HandlerM sub master (Maybe Text)

Get a param (query or post, NOT file)

Get a particular param (query or post, not file)

getQueryParams :: HandlerM sub master [(Text, Text)]

Get all Query params

Get all query params

getQueryParam :: Text -> HandlerM sub master (Maybe Text)

Get a particular Query param

Get a particular query param

getPostParams :: HandlerM sub master [(Text, Text)]

Get all Post params

Get all post params

getPostParam :: Text -> HandlerM sub master (Maybe Text)

Get a particular Post param

Get a particular post param

getFileParams :: HandlerM sub master [(Text, FileInfo)]

Get all File params

Get all file params

getFileParam :: Text -> HandlerM sub master (Maybe FileInfo)

Get a particular File param

Get a particular file param

setCookie :: SetCookie -> HandlerM sub master ()

Sets a cookie to the response

Add a cookie to the response

getCookie :: Text -> HandlerM sub master (Maybe Text)

Get a particular cookie

Get a cookie from the request

getCookies :: HandlerM sub master CookiesText

Get all cookies

Get all cookies from the request

reqVault :: HandlerM sub master Vault

Access the vault

Access the vault from the request

lookupVault :: Key a -> HandlerM sub master (Maybe a)

Lookup a key in the request vault

updateVault :: (Vault -> Vault) -> HandlerM sub master ()

Update the request vault

Bare Handlers

data Env sub master

Constructors

Env

Fields

envMaster :: master

envSub :: sub

envToMaster :: Route sub -> Route master

data RequestData master

An abstract representation of the request data. You can get the wai request object by using waiReq

waiReq :: RequestData master -> Request

Extract the wai Request object from RequestData

nextApp :: RequestData master -> Application

Extract the next Application in the stack

currentRoute :: RequestData master -> Maybe (Route master)

Extract the current Route from RequestData

runNext :: App master

Run the next application in the stack

Run the next application in the stack

module Network.HTTP.Types.Status

module Network.Wai.Middleware.RequestLogger

module Network.Wai.Application.Static