This is the tiny-routes Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:05:28 2024 GMT+0.
tiny-routes/tiny-routes.asdtiny-routes/util.lisptiny-routes/request.lisptiny-routes/response.lisptiny-routes/middleware/builder.lisptiny-routes/middleware/method.lisptiny-routes/middleware/path-template.lisptiny-routes/middleware/query-parameters.lisptiny-routes/middleware/request-body.lisptiny-routes/middleware/response.lisptiny-routes/middleware/middleware.lisptiny-routes/tiny-routes.lisptiny-routes.middlewaretiny-routes.middleware.buildertiny-routes.requesttiny-routes.middleware.request-bodytiny-routes.utiltiny-routes.responsetiny-routes.middleware.query-parameterstiny-routestiny-routes.middleware.responsetiny-routes.middleware.methodtiny-routes.middleware.path-templateThe main system appears first, followed by any subsystem dependency.
tiny-routesA tiny routing library for Common Lisp targeting Clack.
Johnny Ruiz <johnny@ruiz-usa.com>
BSD 3-Clause
0.1.1
cl-ppcre (system).
uiop (system).
util.lisp (file).
request.lisp (file).
response.lisp (file).
middleware (module).
tiny-routes.lisp (file).
Modules are listed depth-first from the system components tree.
tiny-routes/middlewareresponse.lisp (file).
tiny-routes (system).
builder.lisp (file).
method.lisp (file).
path-template.lisp (file).
query-parameters.lisp (file).
request-body.lisp (file).
response.lisp (file).
middleware.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
tiny-routes/tiny-routes.asdtiny-routes/util.lisptiny-routes/request.lisptiny-routes/response.lisptiny-routes/middleware/builder.lisptiny-routes/middleware/method.lisptiny-routes/middleware/path-template.lisptiny-routes/middleware/query-parameters.lisptiny-routes/middleware/request-body.lisptiny-routes/middleware/response.lisptiny-routes/middleware/middleware.lisptiny-routes/tiny-routes.lisptiny-routes/util.lisptiny-routes (system).
compose (function).
pipe (macro).
rfc-1123-date (function).
*day-names* (special variable).
*month-names-3* (special variable).
tiny-routes/request.lisputil.lisp (file).
tiny-routes (system).
clack.io (function).
clack.streaming (function).
content-length (function).
content-type (function).
make-request (function).
path-info (function).
query-string (function).
raw-body (function).
remote-address (function).
remote-port (function).
request (type).
request-append (function).
request-body (function).
request-get (function).
request-header (function).
request-headers (function).
request-method (function).
requestp (function).
script-name (function).
server-name (function).
server-port (function).
server-protocol (function).
uri (function).
url-scheme (function).
with-request (macro).
tiny-routes/response.lisprequest.lisp (file).
tiny-routes (system).
accepted (function).
bad-request (function).
body-mapper-response (compiler macro).
body-mapper-response (function).
body-response (compiler macro).
body-response (function).
clone-response (function).
conflict (function).
created (function).
forbidden (function).
header-response (compiler macro).
header-response (function).
headers-response (compiler macro).
headers-response (function).
headers-response-append (compiler macro).
headers-response-append (function).
internal-server-error (function).
make-response (function).
method-not-allowed (function).
no-content (function).
not-acceptable (function).
not-found (function).
not-implemented (function).
ok (function).
payload-too-large (function).
redirect (function).
response (type).
response-body (function).
response-header (function).
response-headers (function).
response-status (function).
responsep (function).
status-response (compiler macro).
status-response (function).
unauthorized (function).
unprocessable-entity (function).
unsupported-media-type (function).
*deprecated-function-style-warning-body-mapper-response-notified-p* (special variable).
*deprecated-function-style-warning-body-response-notified-p* (special variable).
*deprecated-function-style-warning-header-response-notified-p* (special variable).
*deprecated-function-style-warning-headers-response-append-notified-p* (special variable).
*deprecated-function-style-warning-headers-response-notified-p* (special variable).
*deprecated-function-style-warning-status-response-notified-p* (special variable).
synchronous-response-p (function).
too-many-requests (function).
tiny-routes/middleware/builder.lispmiddleware (module).
wrap-request-mapper (function).
wrap-request-predicate (function).
wrap-response-mapper (function).
wrap-response-mapper* (function).
tiny-routes/middleware/method.lispbuilder.lisp (file).
middleware (module).
wrap-request-matches-method (function).
tiny-routes/middleware/path-template.lispmethod.lisp (file).
middleware (module).
path-parameter (function).
with-path-parameters (macro).
wrap-request-matches-path-template (function).
wrap-request-path-info-matcher (function).
*path-token-scanner* (special variable).
make-path-template-exact-matcher (function).
make-path-template-keyword-matcher (function).
make-path-template-regex-matcher (function).
tiny-routes/middleware/query-parameters.lisppath-template.lisp (file).
middleware (module).
parse-query-parameters (function).
wrap-query-parameters (function).
tiny-routes/middleware/request-body.lispquery-parameters.lisp (file).
middleware (module).
payload-too-large-handler (function).
read-stream-to-string (function).
wrap-request-body (function).
tiny-routes/middleware/response.lisprequest-body.lisp (file).
middleware (module).
wrap-response-body (function).
wrap-response-body-mapper (function).
wrap-response-content-type (function).
wrap-response-header (function).
wrap-response-headers (function).
wrap-response-headers-append (function).
wrap-response-status (function).
tiny-routes/middleware/middleware.lispresponse.lisp (file).
middleware (module).
tiny-routes/tiny-routes.lispmiddleware (module).
tiny-routes (system).
define-any (macro).
define-delete (macro).
define-get (macro).
define-head (macro).
define-options (macro).
define-post (macro).
define-put (macro).
define-route (macro).
define-routes (macro).
routes (function).
wrap-middleware-internal (function).
wrap-post-match-middleware (function).
prepare-route (macro).
Packages are listed by definition order.
tiny-routes.middlewaretiny-routes.middleware.buildertiny-routes.requesttiny-routes.middleware.request-bodytiny-routes.utiltiny-routes.responsetiny-routes.middleware.query-parameterstiny-routestiny-routes.middleware.responsetiny-routes.middleware.methodtiny-routes.middleware.path-templatetiny-routes.middleware.buildercommon-lisp.
wrap-request-mapper (function).
wrap-request-predicate (function).
wrap-response-mapper (function).
wrap-response-mapper* (function).
tiny-routes.requestcommon-lisp.
clack.io (function).
clack.streaming (function).
content-length (function).
content-type (function).
make-request (function).
path-info (function).
query-string (function).
raw-body (function).
remote-address (function).
remote-port (function).
request (type).
request-append (function).
request-body (function).
request-get (function).
request-header (function).
request-headers (function).
request-method (function).
requestp (function).
script-name (function).
server-name (function).
server-port (function).
server-protocol (function).
uri (function).
url-scheme (function).
with-request (macro).
tiny-routes.middleware.request-bodycommon-lisp.
payload-too-large-handler (function).
read-stream-to-string (function).
wrap-request-body (function).
tiny-routes.utilcommon-lisp.
compose (function).
pipe (macro).
rfc-1123-date (function).
*day-names* (special variable).
*month-names-3* (special variable).
tiny-routes.responsecommon-lisp.
accepted (function).
bad-request (function).
body-mapper-response (compiler macro).
body-mapper-response (function).
body-response (compiler macro).
body-response (function).
clone-response (function).
conflict (function).
created (function).
forbidden (function).
header-response (compiler macro).
header-response (function).
headers-response (compiler macro).
headers-response (function).
headers-response-append (compiler macro).
headers-response-append (function).
internal-server-error (function).
make-response (function).
method-not-allowed (function).
no-content (function).
not-acceptable (function).
not-found (function).
not-implemented (function).
ok (function).
payload-too-large (function).
redirect (function).
response (type).
response-body (function).
response-header (function).
response-headers (function).
response-status (function).
responsep (function).
status-response (compiler macro).
status-response (function).
unauthorized (function).
unprocessable-entity (function).
unsupported-media-type (function).
*deprecated-function-style-warning-body-mapper-response-notified-p* (special variable).
*deprecated-function-style-warning-body-response-notified-p* (special variable).
*deprecated-function-style-warning-header-response-notified-p* (special variable).
*deprecated-function-style-warning-headers-response-append-notified-p* (special variable).
*deprecated-function-style-warning-headers-response-notified-p* (special variable).
*deprecated-function-style-warning-status-response-notified-p* (special variable).
synchronous-response-p (function).
too-many-requests (function).
tiny-routes.middleware.query-parameterscommon-lisp.
parse-query-parameters (function).
wrap-query-parameters (function).
tiny-routestiny
common-lisp.
tiny-routes.middleware.
tiny-routes.request.
tiny-routes.response.
tiny-routes.util.
define-any (macro).
define-delete (macro).
define-get (macro).
define-head (macro).
define-options (macro).
define-post (macro).
define-put (macro).
define-route (macro).
define-routes (macro).
routes (function).
wrap-middleware-internal (function).
wrap-post-match-middleware (function).
prepare-route (macro).
tiny-routes.middleware.responsecommon-lisp.
wrap-response-body (function).
wrap-response-body-mapper (function).
wrap-response-content-type (function).
wrap-response-header (function).
wrap-response-headers (function).
wrap-response-headers-append (function).
wrap-response-status (function).
tiny-routes.middleware.methodcommon-lisp.
wrap-request-matches-method (function).
tiny-routes.middleware.path-templatecommon-lisp.
path-parameter (function).
with-path-parameters (macro).
wrap-request-matches-path-template (function).
wrap-request-path-info-matcher (function).
*path-token-scanner* (special variable).
make-path-template-exact-matcher (function).
make-path-template-keyword-matcher (function).
make-path-template-regex-matcher (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a route handler from ROUTES
Pipe VALUE through WRAPPERS by subsequently passing each wrapped value as the first parameter of the next wrapper.
Bind the variables in VARS to the corresponding values present in PATH-PARAMETERS.
Bind the variables in REQUEST-VARS to the corresponding values in REQUEST and evaluate BODY. Each var in REQUEST-VARS can either be a symbol or a list in the form (variable-name keyword-name [default-value]).
Return a response with status HTTP 202 Accepted and BODY.
Return a response with status HTTP 400 Bad Request and BODY.
Return a clone of RESPONSE where body is mapped via BODY-MAPPER. DEPRECATED. Please use ‘tiny:clone-response’ instead.
Return a clone of RESPONSE with BODY.
DEPRECATED. Please use ‘tiny:clone-response’ instead.
Return the clack.io from REQUEST or DEFAULT.
Return the the clack.streaming from REQUEST or DEFAULT.
Return a clone of RESPONSE with the provided STATUS, HEADERS, and BODY.
Return a response with status HTTP 409 Conflict and BODY.
Return the content length from REQUEST or DEFAULT.
Return the content type from REQUEST or DEFAULT.
Return a response with status HTTP 201 Created with a location header of LOCATION and BODY.
Return a response with status HTTP 403 Forbidden and BODY.
Return a clone of RESPONSE with header KEY and VALUE added. DEPRECATED. Please use ‘tiny:clone-response’ instead.
Return a clone of RESPONSE with HEADERS. DEPRECATED. Please use ‘tiny:clone-response’ instead.
Return a clone of RESPONSE with HEADER-KEY and HEADER-VALUE added. DEPRECATED. Please use ‘tiny:clone-response’ instead.
Return a response with status HTTP 500 Internal Server Error and BODY.
Return a new request based on ARGS.
Return a new response with HTTP STATUS, HEADERS, and BODY.
Return a response with status HTTP 405 Method Not Allowed and BODY.
Return a response with status HTTP 204 No Content.
Return a response with status HTTP 406 Not Acceptable and BODY.
Return a response with status HTTP 404 Not Found and BODY.
Return a response with status HTTP 500 Not Implemented and BODY.
Return a response with status HTTP 200 OK and BODY.
Return the path info from REQUEST or DEFAULT.
Return the value mapped to PATH-PARAMETER from REQUEST or DEFAULT.
Return a response with status HTTP 413 Payload Too Large and BODY.
Return a response representing a payload too large to be handled.
Return the query string from REQUEST or DEFAULT.
Return the raw body from REQUEST or DEFAULT.
Read INPUT-STREAM return contents as a string.
If CONTENT-LENGTH is non-nil, it must be a positive integer representing the maximum number of bytes to read from INPUT-STREAM.
Return a response with STATUS and with a location header of LOCATION.
Return the remote address from REQUEST or DEFAULT.
Return the remote port from REQUEST or DEFAULT.
Return a clone of REQUEST containing KEY and VALUE.
Return the request body from REQUEST or DEFAULT.
Return the value associated with KEY in REQUEST or DEFAULT.
Return the header value from REQUEST associated with KEY or DEFAULT.
Return the headers from REQUEST or DEFAULT.
Return the request method from REQUEST or DEFAULT.
Return t if OBJECT is a request.
Return the RESPONSE body.
Return the value of KEY from the headers of RESPONSE.
Return the headers of RESPONSE.
Return the status of RESPONSE.
Return t if OBJECT is a response.
Return a handler which itself calls each handler in HANDLERS and returns the first non-nil response. Otherwise, return nil.
Return the script name from REQUEST or DEFAULT.
Return the server name from REQUEST or DEFAULT.
Return the server port from REQUEST or DEFAULT.
Return the server protocol from REQUEST or DEFAULT.
Return a clone of RESPONSE with STATUS. DEPRECATED. Please use ‘tiny:clone-response’ instead.
Return a response with status HTTP 401 Unauthorized and BODY.
Return a response with status HTTP 422 Unprocessable Entity and BODY.
Return a response with status HTTP 415 Unsupported Media Type and BODY.
Return the request URI from REQUEST or DEFAULT.
Return the URL scheme from REQUEST or DEFAULT.
Wrap HANDLER such that post-match handlers are called.
Wrap HANDLER such that MIDDLEWARE is wrapped after the request is matched.
Wrap HANDLER such that the results of applying QUERY-PARAMETER-PARSER to the query string is made available to the request via ‘:query-parameters’.
Wrap HANDLER such that the result of applying INPUT-STREAM-MAPPER to the request body is made available to the request via ‘:request-body’.
If MAX-BYTES is non-nil, it must be a positive integer representing the
maximum number of bytes to read from INPUT-STREAM.
PAYLOAD-TOO-LARGE-HANDLER is a ‘handler’ called if MAX-BYTES is non nil and the content-length of string is greater than MAX-BYTES.
Return a new handler that calls HANDLER with the result of applying REQUEST-MAPPER to request.
Wrap HANDLER such that it is called only if the request method matches METHOD.
If METHOD is t, nil or ‘:any’, then return HANDLER unchanged.
If METHOD is a list, then wrap handler such that it is called only if
the request method is in the list.
Wrap HANDLER such that it is called only if the request path matches
the PATH-TEMPLATE.
If PATH-TEMPLATE is t, nil, the empty string, or "*", then return
HANDLER unchanged.
If REGEX is non-nil, then interpret path-template as a regular expression.
Wrap HANDLER such that it is called only if the result of applying
PATH-INFO-MATCHER to the request’s path-info returns non-nil.
If the result of applying PATH-INFO-MATCHER to the request is a list, then it is made available to the request under ‘:path-parameters’.
Returns a new handler that calls HANDLER only if the request satisfies REQUEST-PREDICATE.
Wrap HANDLER such that the response content type is set to CONTENT-TYPE.
Wrap HANDLER such that the response headers includes header with KEY and VALUE.
Wrap HANDLER such that the response headers are set to HEADERS.
Wrap HANDLER such that the response headers include HEADERS.
Wrap HANDLER such that it returns the result of applying RESPONSE-MAPPER to response.
Wrap HANDLER such that it returns the result of applying BI-MAPPER to request and response.
Wrap HANDLER such that the response status is set to STATUS.
The cl-ppcre scanner that matches against a path token such as :id in /articles/:id.
Return a closure that accepts a path and returns t when path matches PATH-TEMPLATE.
Return a closure that accepts a path and returns an plist of matched
groups when path matches PATH-TEMPLATE.
For example, a path template for "/users/:user-id" when matched against "/users/1042" returns ‘(:user-id "jeko")’.
Return a closure that accepts a path and returns non-nil if path matches the regex in PATH-TEMPLATE.
Return t if OBJECT is a synchronous response.
Return a response with status HTTP 429 Too Many Requests and BODY.
| Jump to: | A B C D F H I M N O P Q R S T U W |
|---|
| Jump to: | A B C D F H I M N O P Q R S T U W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | B F M P Q R S T U |
|---|
| Jump to: | B F M P Q R S T U |
|---|