Struct trillium::Body[−][src]

pub struct Body(_);

Expand description

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 async fn into_bytes(self) -> Result<Cow<'static, [u8 ]>, Error>

Consume this body and return the full body. 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.

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

Trait Implementations

impl AsyncRead for Body

pub 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. Read more

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. Read more

impl Debug for Body

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

Formats the value using the given formatter. Read more

impl Default for Body

pub fn default() -> Body

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

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

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

Performs the conversion.

impl From<&'static str> for Body

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

Performs the conversion.

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

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

Performs the conversion.

impl From<String> for Body

pub fn from(s: String) -> Body

Performs the conversion.

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

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

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for Body

impl Send for Body

impl Sync for Body

impl Unpin for Body

impl !UnwindSafe for Body

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

fn read(&'a mut self, buf: &'a mut [u8 ]) -> ReadFuture<'a, Self> where
Self: Unpin,

Reads some bytes from the byte stream. Read more

fn read_vectored(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
    Self: Unpin,

Like read(), except it reads into a slice of buffers. Read more

fn read_to_end(
    &'a mut self,
    buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
    Self: Unpin,

Reads the entire contents and appends them to a Vec. Read more

fn read_to_string(
    &'a mut self,
    buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
    Self: Unpin,

Reads the entire contents and appends them to a String. Read more

fn read_exact(&'a mut self, buf: &'a mut [u8 ]) -> ReadExactFuture<'a, Self> where
Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it. Read more

fn bytes(self) -> Bytes<Self>

Converts this [AsyncRead] into a [Stream] of bytes. Read more

fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,

Creates an adapter which will chain this stream with another. Read more

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the reader and changes its type to dyn AsyncRead + Send + 'a. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.