Skip to main content

Module context

Module context 

Source
Expand description

Render context and extractors.

Page, layout and metadata functions declare what they need as arguments; the generated route glue resolves each argument through FromContext:

ⓘ
pub async fn Page(Path(p): Path<PostParams>, cookies: Cookies) -> Result<impl View> { .. }

Arguments that read request data (cookies, headers, query, …) make the route dynamic under rendering = "auto".

Structs§

Auth
Authentication context primitive: set by your auth middleware, read by pages. Auth<T> is Option-like: auth.user() is None for guests.
AuthUser
Wrapper middleware inserts: req.insert_extension(AuthUser(user)).
ClientIp
The client’s IP address, read as crate::Request::client_ip reads it: the first X-Forwarded-For entry when [server] trust_proxy is on, the peer address otherwise. None when neither is known (tests, pre-rendering).
CsrfToken
CSRF token for forms when csrf() middleware or [security] csrf = "token" is used.
Data
Result of the route’s load function: Data(posts): Data<Vec<Post>>.
Extension
A value inserted by middleware (req.insert_extension(user)), e.g. the authenticated user: Extension(user): Extension<User>. Missing values produce a 500 in development with a clear message; use Option<Extension<T>> for optional values.
FormState
Result of the last progressive-enhancement form submission (validation errors / error message), read once from a short-lived flash cookie.
Headers
Request headers.
Nonce
The per-request CSP nonce (for your own inline scripts).
Path
Typed route parameters: Path(p): Path<BlogParams>. A parameter that fails to parse (e.g. /users/abc for id: u64) renders the 404 page.
Query
Parsed query string: Query(q): Query (a map) or Query<T> (typed).
QueryMap
Query parameters as a multi-map.
RequestContext
Everything known about the request being rendered.
RequestInfo
Basic request information.
ResponseHeaders
Add headers to the page response.

Enums§

RenderMode
Whether a render serves a live request or runs at build/revalidation time.

Traits§

FromContext
Resolve a function argument from the render context.

Type Aliases§

Ctx
Shared handle to the context.