Struct RequestBody 

pub struct RequestBody(/* private fields */);

Request body abstraction that will implement a generic read/write interface that does not require mut self to operate upon and can be shared with threads. Peculiarities like transfer and content encoding are handled by the inner implementation and hidden from the actual endpoints.

Concerning equality

Instances of RequestBody are only considered equal if they refer to the exact same underlying stream. The content of the stream is not considered when determining equality as that would require consuming the stream.

Implementations

impl RequestBody

pub fn new_with_data_ref<T: AsRef<[u8]>>(data: T) -> RequestBody

For unit tests or mocks, will mimic new_with_content_length This will call to_vec() on the slice.

pub fn new_with_data(data: Vec<u8>) -> RequestBody

For unit tests or mocks, will mimic new_with_content_length

pub fn new_with_content_length<T: Read + Send + 'static>( read: T, len: u64, ) -> RequestBody

Uncompressed stream with known length.

pub fn new_chunked<T: Read + Send + 'static>(read: T) -> RequestBody

Uncompressed Chunked stream. Content length is not known.

pub fn new_gzip_chunked<T: Read + Send + 'static>( read: T, ) -> TiiResult<RequestBody>

Chunked stream that is gzip compressed. Neither compressed nor uncompressed content lengths are known.

pub fn new_gzip_with_uncompressed_length<T: Read + Send + 'static>( read: T, len: u64, ) -> TiiResult<RequestBody>

GZIP stream with a known length of the uncompressed data. The size of the gzip payload is presumably smaller (not guaranteed) but otherwise unknown.

pub fn new_gzip_with_compressed_content_length<T: Read + Send + 'static>( read: T, len: u64, ) -> TiiResult<RequestBody>

GZIP stream with a known length of the compressed data. The length of the uncompressed data is not known.

impl RequestBody

pub fn as_read(&self) -> impl Read + '_

Turns this struct into a generic Box Read impl. Useful for calling some external library functions.

pub fn read(&self, buf: &mut [u8]) -> Result<usize>

same as std::io::Read trait

pub fn read_to_end(&self, buf: &mut Vec<u8>) -> Result<usize>

same as std::io::Read trait

pub fn read_to_vec(&self) -> Result<Vec<u8>>

Reads all remaining data into a Vec<u8>

pub fn read_exact(&self, buf: &mut [u8]) -> Result<()>

same as std::io::Read trait

pub fn remaining(&self) -> Result<Option<u64>>

Returns the amount of bytes that can be read until the request body is fully consumes. Some types of request bodies do not know this in this case None is returned.

Errors

If the read mutex was poisoned.

Trait Implementations

impl Clone for RequestBody

fn clone(&self) -> RequestBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestBody

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

Formats the value using the given formatter.

impl PartialEq for RequestBody

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for &RequestBody

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

impl Eq for RequestBody