Server.Route
HTML & web
Parse an HTTP method and path into a typed route value.
Build a parser with get / post / …, path segments (s, int, string), and oneOf. Call parse from handle. Attach methodNotAllowed and notFound so unknown methods and paths get clear responses — see examples/02_counter.
Types
Parser
type Parser a b = Parser (List (Alt a bA method-aware path parser.
Examples
get topWithMethod
type WithMethod a = WithMethod (Parser (a -> a) a) aA parser plus a fallback for wrong HTTP methods.
Examples
methodNotAllowed BadMethod (get top)Total
type Total a = Total (Parser (a -> a) a) a aA complete router: method fallback and not-found fallback.
Examples
oneOf [ map Home (get top) ]
|> methodNotAllowed BadMethod
|> notFound MissingValues
</>
infix right 7 (</>) = slashCompose two path parsers in sequence.
Examples
s "blog" </> int<?>
infix left 8 (<?>) = questionMarkParse path, then query parameters.
Examples
s "search" <?> Query.string "q"get
get : UP.Parser a b -> Parser a bMatch GET on a path parser.
Examples
get top
get (s "count")post
post : UP.Parser a b -> Parser a bMatch POST on a path parser.
Examples
post (s "increment")put
put : UP.Parser a b -> Parser a bMatch PUT on a path parser.
Examples
put (s "items" </> int)patch
patch : UP.Parser a b -> Parser a bMatch PATCH on a path parser.
Examples
patch (s "items" </> int)delete
delete : UP.Parser a b -> Parser a bMatch DELETE on a path parser.
Examples
delete (s "items" </> int)map
map : a -> Parser a b -> Parser (b -> c) cWrap a successful match in a constructor (or any function).
Examples
map Home (get top)oneOf
oneOf : List (Parser a b) -> Parser a bTry each route alternative; first match wins in parse.
Examples
oneOf
[ map Home (get top)
, map Increment (post (s "increment"))
]methodNotAllowed
methodNotAllowed : a -> Parser (a -> a) a -> WithMethod aAttach a fallback value when the path matches but the method does not.
Examples
methodNotAllowed BadMethod (get top)notFound
notFound : a -> WithMethod a -> Total aAttach a fallback value when no path matches.
Examples
notFound Missing (methodNotAllowed BadMethod routes)parse
parse : Total a -> Request -> aRun a total router against a request.
Examples
case parse route req of
Home ->
Server.empty 200 []
Missing ->
Server.empty 404 []s
s : String -> UP.Parser a aMatch a literal path segment.
Examples
s "count"int
int : UP.Parser (Int -> a) aConsume one path segment as an Int.
Examples
s "items" </> intstring
string : UP.Parser (String -> a) aConsume one path segment as a String.
Examples
s "topic" </> stringtop
top : UP.Parser a aMatch an empty remaining path (site root).
Examples
get topcustom
custom : String -> (String -> Maybe a) -> UP.Parser (a -> b) bConsume one segment with your own String -> Maybe a decoder.
Examples
custom "USER" UserId.fromStringslash
slash : UP.Parser a b -> UP.Parser b c -> UP.Parser a cCompose two path parsers in sequence (same as </>).
Examples
slash (s "blog") intquestionMark
questionMark : UP.Parser a (query -> b) -> Query.Parser query -> UP.Parser a bParse path, then query parameters (same as <?>).
Examples
questionMark (s "search") (Query.string "q")query
query : Query.Parser query -> UP.Parser (query -> a) aApply a [Url.Parser.Query] parser to the request query string.
Examples
s "search" </> query (Query.string "q")