Struct axum::extract::ContentLengthLimit

pub struct ContentLengthLimit<T, const N: u64>(pub T);

Extractor that will reject requests with a body larger than some size.

GET, HEAD, and OPTIONS requests are rejected if they have a Content-Length header, otherwise they’re accepted without the body being checked.

Example

use axum::{
    extract::ContentLengthLimit,
    routing::post,
    Router,
};

async fn handler(body: ContentLengthLimit<String, 1024>) {
    // ...
}

let app = Router::new().route("/", post(handler));

This requires the request to have a Content-Length header.

If you want to limit the size of request bodies without requiring a Content-Length header, consider using [tower_http::limit::RequestBodyLimitLayer].

Tuple Fields

0: T

Trait Implementations

impl<T: Clone, const N: u64> Clone for ContentLengthLimit<T, N>

fn clone(&self) -> ContentLengthLimit<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: u64> Debug for ContentLengthLimit<T, N>

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

Formats the value using the given formatter.

impl<T, const N: u64> Deref for ContentLengthLimit<T, N>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, B, const N: u64> FromRequest<B> for ContentLengthLimit<T, N> where
    T: FromRequest<B>,
    T::Rejection: IntoResponse,
    B: Send, 

type Rejection = ContentLengthLimitRejection<<T as FromRequest<B>>::Rejection>

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.