RustStruct

Request

Description

The incoming HTTP request in a handler or action: URI, headers, route params, and typed body parsing - body::<T>() decodes a JSON body, form_data::<T>() decodes a url-encoded form. Both return Result<T, BodyParseError>.

Signature

rust

pub struct Request {
    pub uri: Uri,
    /// Wrapped in `Arc` so cloning a `Request` (once per page + once per
    /// ascendant layout handler) shares the header map instead of deep-copying
    /// it. Read access (`req.headers.get(..)`) is unchanged via `Deref`.
    pub headers: Arc<HeaderMap>,
    pub params: HashMap<String, String>,
    body: Option<Vec<u8>>,
}

Examples

Read route params and headers:

rust

#[handler]
async fn show(req: Request) -> PostProps {
    let id = req.params.get("id").unwrap();
    let lang = req.headers.get("accept-language");
    PostProps { post: load(id).await }
}

Parse a JSON body with body::<T>():

rust

#[api(POST)]
async fn create(req: Request) -> Json<Created> {
    let input: NewPost = req.body().unwrap(); // deserialized from JSON
    Json(Created { id: save(input).await })
}

Parse a url-encoded form (application/x-www-form-urlencoded) with form_data::<T>():

rust

#[api(POST)]
async fn login(req: Request) -> Response {
    let form: LoginForm = req.form_data().unwrap();
    authenticate(&form).await
}