Struct UrlEncodedBody

pub struct UrlEncodedBody<T>(pub T);

Parse a URL-encoded request body, such as a web form.

Guide

Check out the relevant section of Pavex’s guide for a thorough introduction to UrlEncodedBody.

Example

use pavex::request::body::UrlEncodedBody;

// You must derive `serde::Deserialize` for the type you want to extract,
// in this case `HomeListing`.
#[derive(serde::Deserialize)]
pub struct HomeListing {
    address: String,
    price: u64,
}

// The `UrlEncodedBody` extractor deserializes the request body into
// the type you specified—`HomeListing` in this case.
pub fn get_home(body: &UrlEncodedBody<HomeListing>) -> String {
    format!(
        "The home you want to sell for {} is located at {}",
        body.0.price,
        body.0.address
    )
}

Tuple Fields

0: T

Implementations

impl<T> UrlEncodedBody<T>

pub fn extract<'head, 'body>( request_head: &'head RequestHead, buffered_body: &'body BufferedBody, ) -> Result<Self, ExtractUrlEncodedBodyError>

where T: Deserialize<'body>,

impl UrlEncodedBody<()>

pub fn register(bp: &mut Blueprint) -> RegisteredConstructor<'_>

Register the default constructor for UrlEncodedBody with a Blueprint.

pub fn default_constructor() -> Constructor

The default constructor and error handler for UrlEncodedBody.

Trait Implementations

impl<T: Debug> Debug for UrlEncodedBody<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.