Struct viceroy_lib::body::Body

pub struct Body { /* private fields */ }

An HTTP request or response body.

Most importantly, this type implements http_body::Body. This type is an alternative to hyper::Body, with facilities to write to an existing body, and to append bodies to one another.

Implementations

impl Body

pub fn empty() -> Self

Get a new, empty body.

pub fn push_back(&mut self, chunk: impl Into<Chunk>)

Push a new chunk onto the body.

pub fn push_front(&mut self, chunk: impl Into<Chunk>)

Push a new chunk onto the front of the body.

pub fn append(&mut self, body: Self)

Append another body to this body.

pub async fn read_into_vec(self) -> Result<Vec<u8>, Error>

Read the entire body into a byte vector.

pub async fn read_into_string(self) -> Result<String, Error>

Read the entire body into a String

Panics

Panics if the body is not valid UTF-8.

pub async fn await_ready(&mut self)

Block until the body has a chunk ready (or is known to be empty).

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

Trait Implementations

impl Body for Body

fn size_hint(&self) -> SizeHint

This is an optional method, but implementing it correctly allows us to reduce the number of cases where bodies get sent with chunked Transfer-Encoding instead of Content-Length.

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

fn poll_data( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Result<Self::Data, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn poll_trailers( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<Option<HeaderMap>, Self::Error>>

Poll for an optional single HeaderMap of trailers.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn data(&mut self) -> Data<'_, Self>

where Self: Sized + Unpin,

Returns future that resolves to next data chunk, if any.

fn trailers(&mut self) -> Trailers<'_, Self>

where Self: Sized + Unpin,

Returns future that resolves to trailers, if any.

fn map_data<F, B>(self, f: F) -> MapData<Self, F>

where Self: Sized, F: FnMut(Self::Data) -> B, B: Buf,

Maps this body’s data value to a different value.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>

where Self: Sized, F: FnMut(Self::Error) -> E,

Maps this body’s error value to a different value.

fn collect(self) -> Collect<Self>

where Self: Sized,

Turn this body into Collected body which will collect all the DATA frames and trailers.

fn boxed(self) -> BoxBody<Self::Data, Self::Error>

where Self: Sized + Send + Sync + 'static,

Turn this body into a boxed trait object.

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>

where Self: Sized + Send + 'static,

Turn this body into a boxed trait object that is !Sync.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Body

Returns the “default value” for a type.

impl Extend<Chunk> for Body

fn extend<I: IntoIterator<Item = Chunk>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Into<Chunk>> From<T> for Body

fn from(chunk: T) -> Self

Converts to this type from the input type.

impl IntoIterator for Body

type Item = Chunk

The type of the elements being iterated over.

type IntoIter = <VecDeque<Chunk> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.