Struct actix_web::web::JsonConfig

pub struct JsonConfig { /* fields omitted */ }

Json extractor configuration

Example

use actix_web::{error, web, App, FromRequest, HttpResponse};
use serde_derive::Deserialize;

#[derive(Deserialize)]
struct Info {
    username: String,
}

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

fn main() {
    let app = App::new().service(
        web::resource("/index.html")
            .app_data(
                // Json extractor configuration for this resource.
                web::JsonConfig::default()
                    .limit(4096) // Limit request payload size
                    .content_type(|mime| {  // <- accept text/plain content type
                        mime.type_() == mime::TEXT && mime.subtype() == mime::PLAIN
                    })
                    .error_handler(|err, req| {  // <- create custom error response
                       error::InternalError::from_response(
                           err, HttpResponse::Conflict().finish()).into()
                    })
            )
            .route(web::post().to(index))
    );
}

Implementations

impl JsonConfig

pub fn limit(self, limit: usize) -> Self

Change max size of payload. By default max size is 32Kb

pub fn error_handler<F>(self, f: F) -> Self where
    F: Fn(JsonPayloadError, &HttpRequest) -> Error + Send + Sync + 'static, 

Set custom error handler

pub fn content_type<F>(self, predicate: F) -> Self where
    F: Fn(Mime) -> bool + Send + Sync + 'static, 

Set predicate for allowed content types

Trait Implementations

impl Clone for JsonConfig

pub fn clone(&self) -> JsonConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for JsonConfig

pub fn default() -> Self

Returns the "default value" for a type.