stch.routing documentation

DSL for routing Ring requests.

*router*

Source
->Router
(->Router req req-path req-method resp)
Positional factory function for class stch.routing.Router.

Source
-body
(-body this)
Returns the request body.

Source
-domain
(-domain this d f)
If the server-name key matches d, call f.

Source
-guard
(-guard this check)(-guard this check msg)
If check is falsey return immediately with a
forbidden error, and optional message.
Source
-headers
(-headers this)
Returns a map of the request headers.

Source
-index
(-index this f)
If there are no path segments, call f.

Source
-lookup-header
(-lookup-header this header)
Returns the specified header.

Source
-lookup-param
(-lookup-param this param)
Returns the specified param.

Source
-method
(-method this meth f)
If the request-method key matches meth,
call f.
Source
-not-traversed
(-not-traversed this f)
If the current path level has not been traversed
previously, call f.
Source
-param
(-param this parser f)
If the next path segment can be matched according
to regex pattern, use the corresponding parser and
pass the result to f.
Source
-params
(-params this)
Returns the params map (if present).

Source
-path
(-path this segment f)
If the next path segment matches segment,
call f.
Source
-pred
(-pred this p f)
If (p path-segment) returns truthy then,
call f passing the result of the above.
Source
-request
(-request this)
Returns the request map.

Source
-scheme
(-scheme this s f)
If the scheme key matches s, call f.

Source
-static
(-static this segments opts)
If the next path segment matches a value in the
segments set and the request method is get,
return a file response corresponding to the
requested file.
Source
-terminate
(-terminate this resp)
Terminate and respond with resp immediately.

Source
-truncate
(-truncate this f)
Truncate any remaining path segments and call f.
If a response is not created inside truncate
(for example, by means of a call to method),
revert the zipper to it's previous state.
Source
-url
(-url this)
Returns the request url.

Source
-zipper
(-zipper this)
Inspect the current state of the zipper. Useful
for debugging.
Source
IDispatch
Dispatch a request.

Source
IRequest
Common request accessors.

Source
Request
Request type annotation.

Source
RequestMethods
Request methods type annotation.

Source
body
macro
(body)
Returns the request body (if present).

Use with route or route'.
Source
defroute
macro
(defroute name & body)
Define a routing Ring handler.

Source
defroute'
macro
(defroute' name & body)
Define a routing Ring handler.

Use with routes.
Source
domain
macro
(domain d & body)
If the server-name key matches d, evaluate body.

Use with route or route'.
Source
guard
macro
(guard check)(guard check msg)
If check is falsey return immediately with a
forbidden error, and optional message.

Use with route or route'.
Source
headers
macro
(headers)
Returns a map of the request headers.

Use with route or route'.
Source
index
macro
(index & body)
If there are no path segments, evaluate body.

Use with route or route'.
Source
init-router
(init-router req)
Inputs: [req :- Request]
Returns: Router

Initialize the router.
Source
lookup-header
macro
(lookup-header header)
Returns the specified header.

Use with route or route'.
Source
lookup-param
macro
(lookup-param param)
Returns the specified param.

Use with route or route'.
Source
map->Router
(map->Router m3921)
Factory function for class Router, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
method
macro
(method method & body)
If the request-method key matches meth,
 evaluate body.

Use with route or route'.
Source
not-traversed
macro
(not-traversed & body)
If the current path level has not been traversed
previously, evaluate body.

Use with route or route'.
Source
param
macro
(param parser bindings & body)
If the next path segment can be matched according
to regex pattern, use the corresponding parser and
evaluate body with bindings set to parsed value.

Use with route or route'.
Source
params
macro
(params)
Returns the params map (if present).

Use with route or route'.
Source
path
macro
(path segment & body)
If the next path segment matches segment,
evaluate body.

Use with route or route'.
Source
pred
macro
(pred p bindings & body)
If (p path-segment) returns truthy then,
evaluate body with bindings set to the value
returned by (p path-segment).

Use with route or route'.
Source
request
macro
(request)
Returns the request map.

Use with route or route'.
Source
route
macro
(route & body)
Entrypoint for routing. Returns a Ring handler.
Calls respond.
Source
route'
macro
(route' & body)
Alternate entrypoint for routing. Returns a Ring
handler. Does not call respond.

Use with routes.
Source
routes
(routes & handlers)
Inputs: [& handlers :- [(Fn Any [Request])]]
Returns: (Fn Any [Request])

Compose multiple routes. Returns a Ring handler.
Calls respond.
Source
scheme
macro
(scheme s & body)
If the scheme key matches s, evaluate body.

Use with route or route'.
Source
static
macro
(static segments opts)
If the next path segment matches a value in the
segments set and the request method is get,
return a file response corresponding to the
requested file.

Use with route or route'.
Source
strict-map->Router
(strict-map->Router m3922 & [drop-extra-keys?__1737__auto__])
Factory function for class Router, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
terminate
macro
(terminate resp)
Terminate and respond with resp immediately.

Use with route or route'.
Source
truncate
macro
(truncate & body)
Truncate any remaining path segments and evaluate body.
If a response is not created inside truncate
(for example, by means of a call to method),
revert the zipper to it's previous state.

Use with route or route'.
Source
url
macro
(url)
Returns the request url.

Use with route or route'.
Source
zipper
macro
(zipper)
Inspect the current state of the zipper. Useful
for debugging.

Use with route or route'.
Source