Network.Wai.Middleware.Routes

This package provides typesafe URLs for Wai applications.

Documentation

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

parseRoutesFile :: FilePath -> Q Exp

A quasi-quoter to parse the contents of a file into a list of Resources. Checks for overlapping routes, failing if present; use parseRoutesFileNoCheck to skip the checking

parseRoutesNoCheck :: QuasiQuoter

Same as parseRoutes, but performs no overlap checking.

parseRoutesFileNoCheck :: FilePath -> Q Exp

Same as parseRoutesFile, but performs no overlap checking.

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

Call this function to automatically generate your route datatype and Route instance

dispatch :: Route route => route -> Middleware

The application dispatcher function. This function takes an instance of Route class as an argument. It is normal to pass (undefined::YourRoute).

data Resource

A single resource pattern.

First argument is the name of the constructor, second is the URL pattern to match, third is how to dispatch.

Constructors

Resource String [Piece] [String]

Instances

Eq Resource

Data Resource

Read Resource

Show Resource

Typeable Resource

Lift Resource

data Piece

A single piece of a URL, delimited by slashes.

In the case of StaticPiece, the argument is the value of the piece; for the other constructors, it is the name of the parameter represented by this piece.

Constructors

StaticPiece String

SinglePiece String

MultiPiece String

Instances

Eq Piece

Data Piece

Read Piece

Show Piece

Typeable Piece

Lift Piece

class Route route where

Instances of this class are autogenerated by mkRoute TH function

Methods

showRoute :: route -> [Text]

readRoute :: [Text] -> Either String route

dispatchRoute :: route -> String -> Maybe Application