Struct trillium::Body

pub struct Body(_);

The trillium representation of a http body. This can contain either &'static [u8] content, Vec<u8> content, or a boxed AsyncRead type.

Implementations

impl Body

pub fn new_streaming(
    async_read: impl AsyncRead + Send + Sync + 'static,
    len: Option<u64>
) -> Body

Construct a new body from a streaming [AsyncRead] source. If you have the body content in memory already, prefer Body::new_static or one of the From conversions.

pub fn new_static(content: impl Into<Cow<'static, [u8]>>) -> Body

Construct a fixed-length Body from a Vec<u8> or &'static [u8].

pub fn static_bytes(&self) -> Option<&[u8]>

Retrieve a borrow of the static content in this body. If this body is a streaming body or an empty body, this will return None.

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

Transform this Body into a dyn AsyncRead. This will wrap static content in a [Cursor]. Note that this is different from reading directly from the Body, which includes chunked encoding.

pub async fn into_bytes(
    self
) -> impl Future<Output = Result<Cow<'static, [u8]>, Error>>

Consume this body and return the full content. If the body was constructed with [Body::new_streaming], this will read the entire streaming body into memory, awaiting the streaming source’s completion. This function will return an error if a streaming body has already been read to completion.

Errors

This returns an error variant if either of the following conditions are met:

• there is an io error when reading from the underlying transport such as a disconnect
• the body has already been read to completion

pub fn bytes_read(&self) -> u64

Retrieve the number of bytes that have been read from this body

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

returns the content length of this body, if known and available.

pub fn is_empty(&self) -> bool

determine if the this body represents no data

pub fn is_static(&self) -> bool

determine if the this body represents static content

pub fn is_streaming(&self) -> bool

determine if the this body represents streaming content

Trait Implementations

impl AsyncRead for Body

fn poll_read(
    self: Pin<&mut Body>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Body

Returns the “default value” for a type.

impl From<&'static [u8]> for Body

fn from(content: &'static [u8]) -> Body

Converts to this type from the input type.

impl From<&'static str> for Body

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

Converts to this type from the input type.

impl<Transport> From<ReceivedBody<'static, Transport>> for Bodywhere
    Transport: 'static + AsyncRead + AsyncWrite + Send + Sync + Unpin,

fn from(rb: ReceivedBody<'static, Transport>) -> Body

Converts to this type from the input type.

impl From<String> for Body

fn from(s: String) -> Body

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Body

fn from(content: Vec<u8, Global>) -> Body

Converts to this type from the input type.