| Portability | non-portable (uses ghc extensions) |
|---|---|
| Stability | experimental |
| Maintainer | ajnsit@gmail.com |
| Safe Haskell | None |
Network.Wai.Middleware.Routes.Routes
Contents
Description
This package provides typesafe URLs for Wai applications.
- parseRoutes :: QuasiQuoter
- parseRoutesFile :: FilePath -> Q Exp
- parseRoutesNoCheck :: QuasiQuoter
- parseRoutesFileNoCheck :: FilePath -> Q Exp
- mkRoute :: String -> [ResourceTree String] -> Q [Dec]
- routeDispatch :: Routable master => master -> Middleware
- showRoute :: RenderRoute master => Route master -> Text
- readRoute :: ParseRoute master => Text -> Maybe (Route master)
- type Handler master = master -> RequestData -> ResourceT IO Response
- class Routable master where
- dispatcher :: Handler master
- class Eq (Route a) => RenderRoute a where
- data Route a1
- renderRoute :: Route a -> ([Text], [(Text, Text)])
- class RenderRoute a => ParseRoute a where
- parseRoute :: ([Text], [(Text, Text)]) -> Maybe (Route a)
- class RenderRoute a => RouteAttrs a where
- routeAttrs :: Route a -> Set Text
- data RequestData
- waiReq :: RequestData -> Request
- nextApp :: RequestData -> Application
- runNext :: RequestData -> ResourceT IO Response
Quasi Quoters
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.
Parse Routes declared inline
parseRoutesFile :: FilePath -> Q Exp
Parse routes declared in a file
parseRoutesNoCheck :: QuasiQuoter
Same as parseRoutes, but performs no overlap checking.
Parse routes declared inline, without checking for overlaps
parseRoutesFileNoCheck :: FilePath -> Q Exp
Parse routes declared in a file, without checking for overlaps
Template Haskell methods
mkRoute :: String -> [ResourceTree String] -> Q [Dec]Source
Generates all the things needed for efficient routing,
including your application's Route datatype, and
RenderRoute, ParseRoute, and RouteAttr instances
Dispatch
routeDispatch :: Routable master => master -> MiddlewareSource
Generates the application middleware from a Routable master datatype
URL rendering and parsing
showRoute :: RenderRoute master => Route master -> TextSource
Renders a Route as Text
readRoute :: ParseRoute master => Text -> Maybe (Route master)Source
Read a route from Text Returns Nothing if Route reading failed. Just route otherwise
Application Handlers
type Handler master = master -> RequestData -> ResourceT IO ResponseSource
A Handler generates an App from the master datatype
Generated Datatypes
class Routable master whereSource
A Routable instance can be used in dispatching.
An appropriate instance for your site datatype is
automatically generated by mkRoute
Methods
dispatcher :: Handler masterSource
Used internally. However needs to be exported for TH to work.
class Eq (Route a) => RenderRoute a where
Methods
renderRoute :: Route a -> ([Text], [(Text, Text)])
A RenderRoute instance for your site datatype is automatically generated by mkRoute
class RenderRoute a => ParseRoute a where
Methods
parseRoute :: ([Text], [(Text, Text)]) -> Maybe (Route a)
A ParseRoute instance for your site datatype is automatically generated by mkRoute
class RenderRoute a => RouteAttrs a where
Methods
routeAttrs :: Route a -> Set Text
A RouteAttrs instance for your site datatype is automatically generated by mkRoute
Accessing Request Data
data RequestData Source
An abstract representation of the request data. You can get the wai request object by using waiReq
waiReq :: RequestData -> RequestSource
Extract the wai Request object from RequestData
Extract the next Application in the stack
Run the next application in the stack