Skip to main content

BodyStream

Struct BodyStream 

Source
pub struct BodyStream { /* private fields */ }
Expand description

A request body that is read in pieces, see the module documentation

Implementations§

Source§

impl BodyStream

Source

pub fn content_length(&self) -> Option<u64>

Size announced by the client (Content-Length), if any. Untrusted; the limit is checked against what actually arrives.

Source

pub fn bytes_read(&self) -> u64

Bytes delivered so far

Source

pub async fn chunk(&mut self) -> Result<Option<Bytes>>

The next piece, or None at the end. Fails with 413 as soon as the limit is exceeded, and with 400 when the connection breaks mid-body.

Source

pub async fn copy_to<W: AsyncWrite + Unpin>( &mut self, writer: &mut W, ) -> Result<u64>

Write the rest of the body to writer; returns the bytes copied

Source

pub async fn save_to(&mut self, path: impl AsRef<Path>) -> Result<u64>

Write the rest of the body to a file; returns the bytes written

The file is created or replaced. If the body is cut off, too large or the write fails, the partial file is removed. Use a temporary name and rename it afterwards when readers must never see half-written data.

Source

pub async fn collect(&mut self) -> Result<Bytes>

Read the rest into memory, still bounded by the limit

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> 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 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 = !

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

fn try_from(value: U) -> Result<T, !>

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