Struct pavex::request::body::BufferedBody

#[non_exhaustive]
pub struct BufferedBody {
    pub bytes: Bytes,
}

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)

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

impl BufferedBody

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.

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

Register the default constructor for BufferedBody with a Blueprint.

pub fn default_constructor() -> Constructor

The default constructor and error handler for BufferedBody.

Trait Implementations

impl Clone for BufferedBody

fn clone(&self) -> BufferedBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufferedBody

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

Formats the value using the given formatter.

impl From<BufferedBody> for Bytes

fn from(buffered_body: BufferedBody) -> Self

Converts to this type from the input type.