Struct pavex::request::body::BufferedBody

source ·
#[non_exhaustive]
pub struct BufferedBody { pub bytes: Bytes, }
Expand description

Buffer the entire body of an incoming request in memory.

§Guide

BufferedBody is the ideal building block for other extractors that need to have the entire body available in memory to do their job (e.g. JsonBody).
It can also be useful if you need to access the raw bytes of the body ahead of deserialization (e.g. to compute its hash as a step of a signature verification process).

Check out the “Low-level access” section of Pavex’s guide for a thorough introduction to BufferedBody.

§Security

BufferedBody includes a size limit to prevent denial-of-service attacks. Check out the guide for examples on how to configure it.

§Example

use pavex::http::StatusCode;
use pavex::request::body::BufferedBody;

// The `BufferedBody` extractor consumes the raw request body stream
// and buffers its entire contents in memory.
pub fn handler(body: &BufferedBody) -> StatusCode {
    format!(
        "The incoming request contains {} bytes",
        body.bytes.len(),
    );
    // [...]
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§bytes: Bytes

The buffer of bytes that represents the body of the incoming request.

Implementations§

source§

impl BufferedBody

source

pub async fn extract( request_head: &RequestHead, body: RawIncomingBody, body_size_limit: BodySizeLimit, ) -> Result<Self, ExtractBufferedBodyError>

Default constructor for BufferedBody.

If extraction fails, an ExtractBufferedBodyError is returned.

source

pub fn register(bp: &mut Blueprint) -> RegisteredConstructor<'_>

Register the default constructor for BufferedBody with a Blueprint.

source

pub fn default_constructor() -> Constructor

Trait Implementations§

source§

impl Clone for BufferedBody

source§

fn clone(&self) -> BufferedBody

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BufferedBody

source§

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

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

impl From<BufferedBody> for Bytes

source§

fn from(buffered_body: BufferedBody) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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 T
where 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 for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

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 T
where U: TryFrom<T>,

source§

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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