Skip to main content

Body

Struct Body 

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

A response body as it arrives, read once.

An implementation builds one with Body::from_stream, passing along the length the transport knows so a body declared past the caller’s cap is refused before a byte of it is read. The SDK reads it with Body::chunk or Body::collect.

Implementations§

Source§

impl Body

Source

pub fn from_stream( stream: impl Stream<Item = Result<Bytes, Error>> + Send + 'static, content_length: Option<u64>, ) -> Body

A body over the transport’s stream of chunks, with the length it declared, if any.

Source

pub fn empty() -> Body

A body with nothing in it, for an answer that carries none.

Source

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

What the transport declared the body’s length to be, when it declared one.

Source

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

The next piece of the body, or None once it has all arrived.

Source

pub async fn collect( self, limit: usize, too_large: impl Fn() -> Error, ) -> Result<Bytes, Error>

Reads the body whole, up to limit bytes, and answers too_large on the first byte past. A body exactly at the limit reads whole; one declared past it never starts.

Trait Implementations§

Source§

impl Debug for Body

Source§

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

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

impl From<&'static str> for Body

Source§

fn from(text: &'static str) -> Body

Converts to this type from the input type.
Source§

impl From<Bytes> for Body

Source§

fn from(bytes: Bytes) -> Body

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for Body

Source§

fn from(bytes: Vec<u8>) -> Body

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Body

§

impl !Sync for Body

§

impl !UnwindSafe for Body

§

impl Freeze for Body

§

impl Send for Body

§

impl Unpin for Body

§

impl UnsafeUnpin 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: 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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