impl DefaultBodyLimit

const fn disable() -> Self

Disable the default request body limit.

This must be used to receive bodies larger than the default limit of 2MB using Bytes or an extractor built on it such as String, Json, Form.

Note that if you're accepting data from untrusted remotes it is recommend to add your own limit such as tower_http::limit.

Example

use axum::{
    Router,
    routing::get,
    body::{Bytes, Body},
    extract::DefaultBodyLimit,
};
use tower_http::limit::RequestBodyLimitLayer;

let app: Router<()> = Router::new()
    .route("/", get(|body: Bytes| async {}))
    // Disable the default limit
    .layer(DefaultBodyLimit::disable())
    // Set a different limit
    .layer(RequestBodyLimitLayer::new(10 * 1000 * 1000));

const fn max(limit: usize) -> Self

Set the default request body limit.

By default the limit of request body sizes that Bytes::from_request (and other extractors built on top of it such as String, Json, and Form) is 2MB. This method can be used to change that limit.

Example

use axum::{
    Router,
    routing::get,
    body::{Bytes, Body},
    extract::DefaultBodyLimit,
};

let app: Router<()> = Router::new()
    .route("/", get(|body: Bytes| async {}))
    // Replace the default of 2MB with 1024 bytes.
    .layer(DefaultBodyLimit::max(1024));

fn apply<B>(self, req: &mut Request<B>)

Apply a request body limit to the given request.

This can be used, for example, to modify the default body limit inside a specific extractor.

Example

An extractor similar to Bytes, but limiting the body to 1 KB.

use axum::{
    extract::{DefaultBodyLimit, FromRequest, rejection::BytesRejection, Request},
    body::Bytes,
};

struct Bytes1KB(Bytes);

impl<S: Sync> FromRequest<S> for Bytes1KB {
    type Rejection = BytesRejection;

    async fn from_request(mut req: Request, _: &S) -> Result<Self, Self::Rejection> {
        DefaultBodyLimit::max(1024).apply(&mut req);
        Ok(Self(Bytes::from_request(req, &()).await?))
    }
}