pub struct BodyLimit<T, const LIMIT: usize = DEFAULT_BODY_LIMIT> { /* private fields */ }
Expand description

Extractor wrapper that limits size of payload used.

Examples

use actix_web::{Responder, get, web::Bytes};
use actix_web_lab::extract::BodyLimit;

const BODY_LIMIT: usize = 1_048_576; // 1MB

#[get("/")]
async fn handler(body: BodyLimit<Bytes, BODY_LIMIT>) -> impl Responder {
    let body = body.into_inner();
    assert!(body.len() < BODY_LIMIT);
    body
}

Implementations§

source§

impl<T, const LIMIT: usize> BodyLimit<T, LIMIT>

source

pub fn into_inner(self) -> T

Returns inner extracted type.

Trait Implementations§

source§

impl<T, const LIMIT: usize> AsRef<T> for BodyLimit<T, LIMIT>

source§

fn as_ref(&self) -> &T

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

impl<T: Debug, const LIMIT: usize> Debug for BodyLimit<T, LIMIT>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T, const LIMIT: usize> Display for BodyLimit<T, LIMIT>where T: Display,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T, const LIMIT: usize> From<T> for BodyLimit<T, LIMIT>

source§

fn from(original: T) -> BodyLimit<T, LIMIT>

Converts to this type from the input type.
source§

impl<T, const LIMIT: usize> FromRequest for BodyLimit<T, LIMIT>where T: FromRequest + 'static, T::Error: Debug + Display,

§

type Error = BodyLimitError<T>

The associated error which can be returned.
§

type Future = BodyLimitFut<T, LIMIT>

Future that resolves to a Self. Read more
source§

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

Create a Self from request parts asynchronously.
source§

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

Create a Self from request head asynchronously. Read more
source§

impl<T: PartialEq, const LIMIT: usize> PartialEq<BodyLimit<T, LIMIT>> for BodyLimit<T, LIMIT>

source§

fn eq(&self, other: &BodyLimit<T, LIMIT>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: Eq, const LIMIT: usize> Eq for BodyLimit<T, LIMIT>

source§

impl<T, const LIMIT: usize> StructuralEq for BodyLimit<T, LIMIT>

source§

impl<T, const LIMIT: usize> StructuralPartialEq for BodyLimit<T, LIMIT>

Auto Trait Implementations§

§

impl<T, const LIMIT: usize> RefUnwindSafe for BodyLimit<T, LIMIT>where T: RefUnwindSafe,

§

impl<T, const LIMIT: usize> Send for BodyLimit<T, LIMIT>where T: Send,

§

impl<T, const LIMIT: usize> Sync for BodyLimit<T, LIMIT>where T: Sync,

§

impl<T, const LIMIT: usize> Unpin for BodyLimit<T, LIMIT>where T: Unpin,

§

impl<T, const LIMIT: usize> UnwindSafe for BodyLimit<T, LIMIT>where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more