Struct actix_web::web::JsonConfig

pub struct JsonConfig { /* private fields */ }

Json extractor configuration.

Examples

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

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

// `Json` extraction is bound by custom `JsonConfig` applied to App.
#[post("/")]
async fn index(info: web::Json<Info>) -> String {
    format!("Welcome {}!", info.name)
}

// custom `Json` extractor configuration
let json_cfg = web::JsonConfig::default()
    // limit request payload size
    .limit(4096)
    // only accept text/plain content type
    .content_type(|mime| mime == mime::TEXT_PLAIN)
    // use custom error handler
    .error_handler(|err, req| {
        error::InternalError::from_response(err, HttpResponse::Conflict().into()).into()
    });

App::new()
    .app_data(json_cfg)
    .service(index);

Implementations

impl JsonConfig

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

Set maximum accepted payload size. By default this limit is 2MB.

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.

pub fn content_type_required(self, content_type_required: bool) -> Self

Sets whether or not the request must have a Content-Type header to be parsed.

Trait Implementations

impl Clone for JsonConfig

fn clone(&self) -> JsonConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for JsonConfig

fn default() -> Self

Returns the “default value” for a type.