No matching definitions.

← Home

Exported

Internal

Spices

Turmeric

Community

tourist/param

src/tourist/param.tur

query-string parser and path-capture helpers.

Since: v0.1.0

defn

tourist-ctx-caps

(tourist-ctx-caps [ctx : int] :)

raw __tourist_caps handle stored in a ctx.

Parameters
ctx:int tourist context handle
Returns

:int -- captures handle (may be 0)

Since: v0.1.0

defn

tourist-ctx-strip-path

(tourist-ctx-strip-path [ctx : int new-path : cstr] :)

swap ctx->path with new-path and return the old.

Parameters
ctx:int tourist ctx handle
new-path:cstr new value for ctx->path
Returns

:cstr -- previous ctx->path value; pass it back in to restore.

Since: v0.2.0

defn

req-full-path

(req-full-path [ctx : int] :)

original request path before any url-map! stripping.

Parameters
ctx:int tourist ctx handle
Returns

:cstr -- the original (unstripped) request path

Example
;; Request: GET /api/users  ;; sub-app mounted at /api
  (req-path      ctx)  ;; => "/users"
  (req-full-path ctx)  ;; => "/api/users"

Since: v0.2.0

defn

tourist-ctx-new

(tourist-ctx-new [req : int caps : int] :)

wrap an httpd request + captures into a tourist ctx.

Parameters
req:int httpd request handle (caller retains ownership)
caps:int captures handle from router-match (ctx takes ownership)
Returns

:int -- tourist ctx handle; free with tourist-ctx-free

Example
(let [ctx (tourist-ctx-new req caps)]
    ...)

Since: v0.1.0

defn

tourist-ctx-free

(tourist-ctx-free [ctx : int] :)

release a tourist ctx and its owned resources.

Parameters
ctx:int tourist ctx handle, or 0 (no-op)
Returns

:void

Example
(tourist-ctx-free ctx)

Since: v0.1.0

defn

param

(param [ctx : int key : cstr] :)

look up a query parameter by key.

Parameters
ctx:int tourist ctx handle (from tourist-ctx-new or passed by app)
keyquery parameter name, e.g. "q" for ?q=hello
Returns

:int -- result<:cstr>: ok(value) if found, err("missing") otherwise

Example
(let [r (param req "q")]
    (when (ok? r) (ok-val r)))

Since: v0.1.0

defn

capture

(capture [ctx : int name : cstr] :)

look up a path-segment capture by name.

Parameters
ctx:int tourist ctx handle
namecapture name, e.g. "id" for ":id", or "*" for wildcard
Returns

:int -- result<:cstr>: ok(value) if found, err("missing") otherwise

Example
(let [r (capture req "name")]
    (when (ok? r) (ok-val r)))

Since: v0.1.0

Internal definitions
__parse-qp-- parse a raw query string into parallel key/value arrays.
__tourist-ctx-alloc
__ctx-free-qp
__ctx-free-struct