Struct Json

pub struct Json<T>(pub T);

Json can be used for exstracting typed information and validation from request’s payload.

To extract and typed information from request’s body, the type T must implement the Deserialize trait from serde and Validate trait from validator crate.

JsonConfig allows to configure extraction process.

Example

use actix_web::{web, App};
use actix_web_validator::Json;
use serde::Deserialize;
use validator::Validate;

#[derive(Deserialize, Validate)]
struct Info {
    #[validate(length(min = 3))]
    username: String,
}

/// deserialize `Info` from request's body
async fn index(info: Json<Info>) -> String {
    format!("Welcome {}!", info.username)
}

fn main() {
    let app = App::new().service(
       web::resource("/index.html").route(
           web::post().to(index))
    );
}

Tuple Fields

0: T

Implementations

impl<T> Json<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

impl<T> AsRef<T> for Json<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Formats the value using the given formatter.

impl<T> Deref for Json<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> FromRequest for Json<T>

where T: DeserializeOwned + Validate + 'static,

Json extractor. Allow to extract typed information from request’s payload and validate it.

To extract typed information from request’s body, the type T must implement the Deserialize trait from serde.

To validate payload, the type T must implement the Validate trait from validator crate.

JsonConfig allows to configure extraction process.

Example

use actix_web::{web, App};
use actix_web_validator::Json;
use serde::Deserialize;
use validator::Validate;

#[derive(Deserialize, Validate)]
struct Info {
    #[validate(length(min = 3))]
    username: String,
}

/// deserialize `Info` from request's body
async fn index(info: Json<Info>) -> String {
    format!("Welcome {}!", info.username)
}

fn main() {
    let app = App::new().service(
       web::resource("/index.html").route(
           web::post().to(index))
    );
}

type Error = Error

The associated error which can be returned.

type Future = Pin<Box<dyn Future<Output = Result<Json<T>, <Json<T> as FromRequest>::Error>>>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.