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 b

A method-aware path parser.

Examples

get top

WithMethod

type WithMethod a = WithMethod (Parser (a -> a) a) a

A parser plus a fallback for wrong HTTP methods.

Examples

methodNotAllowed BadMethod (get top)

Total

type Total a = Total (Parser (a -> a) a) a a

A complete router: method fallback and not-found fallback.

Examples

oneOf [ map Home (get top) ]
    |> methodNotAllowed BadMethod
    |> notFound Missing

Values

</>

infix right 7 (</>) = slash

Compose two path parsers in sequence.

Examples

s "blog" </> int

<?>

infix left 8 (<?>) = questionMark

Parse path, then query parameters.

Examples

s "search" <?> Query.string "q"

get

get : UP.Parser a b -> Parser a b

Match GET on a path parser.

Examples

get top
get (s "count")

post

post : UP.Parser a b -> Parser a b

Match POST on a path parser.

Examples

post (s "increment")

put

put : UP.Parser a b -> Parser a b

Match PUT on a path parser.

Examples

put (s "items" </> int)

patch

patch : UP.Parser a b -> Parser a b

Match PATCH on a path parser.

Examples

patch (s "items" </> int)

delete

delete : UP.Parser a b -> Parser a b

Match DELETE on a path parser.

Examples

delete (s "items" </> int)

map

map : a -> Parser a b -> Parser (b -> c) c

Wrap a successful match in a constructor (or any function).

Examples

map Home (get top)

oneOf

oneOf : List (Parser a b) -> Parser a b

Try 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 a

Attach a fallback value when the path matches but the method does not.

Examples

methodNotAllowed BadMethod (get top)

notFound

notFound : a -> WithMethod a -> Total a

Attach a fallback value when no path matches.

Examples

notFound Missing (methodNotAllowed BadMethod routes)

parse

parse : Total a -> Request -> a

Run 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 a

Match a literal path segment.

Examples

s "count"

int

int : UP.Parser (Int -> a) a

Consume one path segment as an Int.

Examples

s "items" </> int

string

string : UP.Parser (String -> a) a

Consume one path segment as a String.

Examples

s "topic" </> string

top

top : UP.Parser a a

Match an empty remaining path (site root).

Examples

get top

custom

custom : String -> (String -> Maybe a) -> UP.Parser (a -> b) b

Consume one segment with your own String -> Maybe a decoder.

Examples

custom "USER" UserId.fromString

slash

slash : UP.Parser a b -> UP.Parser b c -> UP.Parser a c

Compose two path parsers in sequence (same as </>).

Examples

slash (s "blog") int

questionMark

questionMark : UP.Parser a (query -> b) -> Query.Parser query -> UP.Parser a b

Parse path, then query parameters (same as <?>).

Examples

questionMark (s "search") (Query.string "q")

query

query : Query.Parser query -> UP.Parser (query -> a) a

Apply a [Url.Parser.Query] parser to the request query string.

Examples

s "search" </> query (Query.string "q")