Struct JsonBody

pub struct JsonBody<T>(pub T);

Parse the body of an incoming request as JSON.

Guide

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

Example

use pavex::request::body::JsonBody;

// 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 `Json` extractor deserializes the request body into
// the type you specified—`HomeListing` in this case.
pub fn get_home(body: &JsonBody<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> JsonBody<T>

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

where T: Deserialize<'body>,

The default constructor for JsonBody.

The extraction can fail for a number of reasons:

• the Content-Type is missing
• the Content-Type header is not set to application/json or another application/*+json MIME type
• the request body is not a valid JSON document

In all of the above cases, an ExtractJsonBodyError is returned.

impl JsonBody<()>

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

Register the default constructor for JsonBody with a Blueprint.

pub fn default_constructor() -> Constructor

The default constructor and error handler for JsonBody.

Trait Implementations

impl<T: Debug> Debug for JsonBody<T>

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

Formats the value using the given formatter.