Skip to main content

Body

Enum Body 

Source
pub enum Body {
    Empty,
    Bytes(Vec<u8>),
    Stream(RequestBodyStream),
}
Expand description

Request body.

Variants§

§

Empty

Empty body.

§

Bytes(Vec<u8>)

Bytes body.

§

Stream(RequestBodyStream)

Streaming body for large uploads.

This variant enables memory-efficient handling of large request bodies by yielding chunks incrementally rather than buffering the entire content.

The stream yields Result<Vec<u8>, RequestBodyStreamError> chunks.

Implementations§

Source§

impl Body

Source

pub fn into_bytes(self) -> Vec<u8>

Get body as bytes, consuming it.

For Body::Stream, this will panic. Use into_bytes_async() instead for streaming bodies, or check with is_streaming() first.

Source

pub async fn into_bytes_async(self) -> Result<Vec<u8>, RequestBodyStreamError>

Get body as bytes asynchronously, consuming it.

This works for all body types:

  • Empty returns an empty Vec
  • Bytes returns the bytes
  • Stream collects all chunks into a Vec
§Errors

Returns an error if the stream encounters an error while reading.

Source

pub fn is_empty(&self) -> bool

Check if body is empty.

Source

pub fn is_streaming(&self) -> bool

Check if body is a streaming body.

Source

pub fn take_stream(self) -> Option<RequestBodyStream>

Take the body stream, if this is a streaming body.

Returns None for Empty and Bytes variants.

Source

pub fn streaming<S>(stream: S) -> Self
where S: Stream<Item = Result<Vec<u8>, RequestBodyStreamError>> + Send + Sync + 'static,

Create a streaming body.

Source

pub fn streaming_with_size<S>(stream: S, size: usize) -> Self
where S: Stream<Item = Result<Vec<u8>, RequestBodyStreamError>> + Send + Sync + 'static,

Create a streaming body with a known size.

Trait Implementations§

Source§

impl Debug for Body

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Body

§

impl !RefUnwindSafe for Body

§

impl Send for Body

§

impl Sync for Body

§

impl Unpin for Body

§

impl !UnwindSafe for Body

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> 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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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 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, 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.
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
Source§

impl<T> ResponseProduces<T> for T