Struct fire_http::body::BodyWithTimeout

pub struct BodyWithTimeout { /* private fields */ }

Adds a timeout to any Body.

Implementations

impl BodyWithTimeout

pub fn from_hyper_body(
    body: Body,
    max_size: usize,
    timeout: Duration
) -> BodyWithTimeout

Creates a BodyWithTimeout from a hyper::Body.

Panics while reading

If the body was already read more than the max_size or the max_size is 0.

pub fn take(&mut self) -> BodyWithTimeout

Creates a new BodyWithTimeout leaving the old one, with an empty Body.

pub fn into_body(self) -> Body

Returns the underlying Body.

Note

This removes the timeout.

pub fn body(&self) -> &Body

Returns a reference to the underlying Body.

pub fn body_mut(&mut self) -> &mut Body

Returns a mutable reference to the underlying Body.

Note

Calls to the body won’t have a timeout.

pub fn is_empty(&self) -> bool

Checks if the body is empty.

Note

This only checks if Body is Body::Empty.

pub fn set_size_limit(&mut self, max_size: usize) -> bool

Sets a read size limit to the HyperBody. Returns true if the size limit was set.

Note

Works only with the hyper_body feature.
When the size limit is reached an io::Error::Other with SizeLimitReached is returned.

Panics while reading

If the body was already read more than the max_size or the max_size is 0.

pub fn set_timeout(&mut self, timeout: Duration)

Sets the timeout.

pub async fn into_more_bytes(self) -> Result<MoreBytes, Error>

Converts the body into MoreBytes returning an error if reading failed or the size limit was reached.

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

Converts the body into a Vector.

Note

If possible, avoid this function as it is really inefficient.

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

Converts the body into a String.

Note

If possible, avoid this function as it is really inefficient.
For tests or quick debugging however it is quite suitable.

pub async fn as_slice(&'_ mut self) -> Result<&'_ [u8], Error>

Converts the body into to Body::Bytes, returning the slice.

Note

If possible, avoid this function as it is really inefficient.

pub async fn copy_to_async_write<W>(
    self,
    writer: &'_ mut W
) -> Result<(), Error> where
    W: AsyncWrite + Unpin, 

Writes the entire body to an AsyncWrite implementer.

Trait Implementations

impl Debug for BodyWithTimeout

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

Formats the value using the given formatter.