Enum HttpReader

pub enum HttpReader<R> {
    SizedReader(R, u64),
    ChunkedReader(R, Option<u64>),
    EofReader(R),
    EmptyReader(R),
}

Readers to handle different Transfer-Encodings.

If a message body does not include a Transfer-Encoding, it should include a Content-Length header.

Variants

SizedReader(R, u64)

A Reader used when a Content-Length header is passed with a positive integer.

ChunkedReader(R, Option<u64>)

A Reader used when Transfer-Encoding is chunked.

EofReader(R)

A Reader used for responses that don’t indicate a length or chunked.

Note: This should only used for Responses. It is illegal for a Request to be made with both Content-Length and Transfer-Encoding: chunked missing, as explained from the spec:

If a Transfer-Encoding header field is present in a response and the chunked transfer coding is not the final encoding, the message body length is determined by reading the connection until it is closed by the server. If a Transfer-Encoding header field is present in a request and the chunked transfer coding is not the final encoding, the message body length cannot be determined reliably; the server MUST respond with the 400 (Bad Request) status code and then close the connection.

EmptyReader(R)

A Reader used for messages that should never have a body.

See https://tools.ietf.org/html/rfc7230#section-3.3.3

Implementations

impl<R> HttpReader<R>

where R: Read,

pub fn into_inner(self) -> R

Unwraps this HttpReader and returns the underlying Reader.

pub fn get_ref(&self) -> &R

Gets a borrowed reference to the underlying Reader.

pub fn get_mut(&mut self) -> &mut R

Gets a mutable reference to the underlying Reader.

Trait Implementations

impl<R> Debug for HttpReader<R>

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

Formats the value using the given formatter.

impl<R> Read for HttpReader<R>

where R: Read,

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

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” adaptor 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.