Struct axum::extract::Json

pub struct Json<T>(pub T);

Extractor that deserializes request bodies into some type.

T is expected to implement serde::Deserialize.

Example

use axum::prelude::*;
use serde::Deserialize;

#[derive(Deserialize)]
struct CreateUser {
    email: String,
    password: String,
}

async fn create_user(payload: extract::Json<CreateUser>) {
    let payload: CreateUser = payload.0;

    // ...
}

let app = route("/users", post(create_user));

If the query string cannot be parsed it will reject the request with a 400 Bad Request response.

The request is required to have a Content-Type: application/json header.

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Json<T>

fn clone(&self) -> Json<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Json<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Json<T>

fn default() -> Json<T>

Returns the “default value” for a type.

impl<T, B> FromRequest<B> for Json<T> where
    T: DeserializeOwned,
    B: Body + Send,
    B::Data: Send,
    B::Error: Into<BoxError>, 

type Rejection = JsonRejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>(
    req: &'life0 mut RequestParts<B>
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Perform the extraction.

impl<T: Copy> Copy for Json<T>