Context

Request context with access to request data and response methods.

Request Data

param(name: string): string?

Get path parameter.

// Route: /users/:id
let id = ctx.param("id");

query(name: string): string?

Get query parameter.

// URL: /search?q=navi
let q = ctx.query("q");

header(name: string): string?

Get request header.

let auth = ctx.header("Authorization");

body(): string

Get raw request body.

let data = ctx.body();

bind_json<T>(): T

Parse JSON body into struct.

let user = try ctx.bind_json::<User>();

cookie(name: string): string?

Get cookie value.

let session = ctx.cookie("session_id");

Response Methods

status(code: int)

Set response status code.

ctx.status(201);

header(name: string, value: string)

Set response header.

ctx.header("X-Custom", "value");

string(body: string)

Send plain text response.

ctx.string("Hello");

json(data: T)

Send JSON response.

try ctx.json({"status": "ok"});

html(body: string)

Send HTML response.

ctx.html("<h1>Hello</h1>");

data(content_type: string, bytes: Bytes)

Send binary response.

ctx.data("image/png", image_bytes);

redirect(url: string)

Send 302 redirect.

try ctx.redirect("/new-path");

redirect_permanent(url: string)

Send 301 redirect.

try ctx.redirect_permanent("/moved");

set_cookie(name: string, value: string)

Set a cookie.

ctx.set_cookie("theme", "dark");

set_cookie_with_options(name, value, options)

Set cookie with options.

ctx.set_cookie_with_options("session", token, CookieOptions {
    max_age: 3600,
    http_only: true,
    secure: true,
});

delete_cookie(name: string)

Delete a cookie.

ctx.delete_cookie("session");

Middleware

next()

Continue to next handler in chain.

try ctx.next();

Properties

request: Request

The HTTP request object.

response: Response

The HTTP response object.