Enum fire_http::body::Body

source · [−]

pub enum Body {
    Bytes(Bytes),
    MoreBytes(MoreBytes),
    HyperBody(HyperBodyStream),
    AsyncRead(Pin<Box<dyn AsyncRead + Send + Sync + 'static, Global>>),
    BytesStream(Pin<Box<dyn BytesStream + Send + Sync + 'static, Global>>),
    Empty,
}

Expand description

The body for any request or response.

Variants

`Bytes(Bytes)`

`MoreBytes(MoreBytes)`

`HyperBody(HyperBodyStream)`

only available if the feature hyper_body is enabled.

`AsyncRead(Pin<Box<dyn AsyncRead + Send + Sync + 'static, Global>>)`

`BytesStream(Pin<Box<dyn BytesStream + Send + Sync + 'static, Global>>)`

`Empty`

Implementations

source

impl Body

source

pub fn new() -> Body

Creates a new empty body.

source

pub fn from_bytes(bytes: B) -> Body where
B: Into<Bytes>,

Creates a new body with the give bytes, an empty body is returned if bytes is empty.

source

pub fn copy_from_slice(slice: &[u8 ]) -> Body

Creates a new Body::Bytes from the given bytes if the slice is not empty.

source

pub fn is_empty(&self) -> bool

Returns if self is Body::Empty.

source

pub fn take(&mut self) -> Body

Returns this instance and replaces self with Body::empty.

source

pub fn replace(&mut self, other: Body) -> Body

Replaces the body with a new one.

source

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

Returns a length if it is already known.

Note

Body::Empty is returned as Some(0).

source

pub fn from_async_read<R>(reader: R) -> Body where
R: 'static + AsyncRead + Send + Sync,

Creates a new Body from an AsyncRead implementation. This puts the AsyncRead in a box.

source

pub fn from_bytes_stream<S>(stream: S) -> Body where
S: 'static + BytesStream + Send + Sync,

Creates a new Body from an BytesStream implementation. This puts the BytesStream in a box.

source

pub fn from_hyper_body(body: Body) -> Body

Creates a new Body from a hyper Body. Aftwards you can set a size limit with set_size_limit.

Note

Works only with the hyper_body feature.

source

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.

source

pub fn into_http_body(
self
) -> StreamHttpBody<Pin<Box<dyn BytesStream + Send + Sync + 'static, Global>>>

Converts the Body to a StreamHttpBody which implements http_body::Body, useful when using hyper.

source

pub fn into_bytes_stream(
self
) -> Pin<Box<dyn BytesStream + Send + Sync + 'static, Global>>

Converts the Body to a boxed BytesStream.

source

pub fn into_async_read(
self
) -> Pin<Box<dyn AsyncRead + Send + Sync + 'static, Global>>

Converts the Body to a boxed AsyncRead.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn add_timeout(self, timeout: Duration) -> BodyWithTimeout

Creates a Body with a timeout.

Note

The timer starts when the first read is performed.

Trait Implementations

source

impl Debug for Body

source

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

Formats the value using the given formatter. Read more

source

impl Default for Body

source

fn default() -> Body

Returns the “default value” for a type. Read more

source