Struct attohttpc::ResponseReader

pub struct ResponseReader { /* private fields */ }

The ResponseReader is used to read the body of a response.

The ResponseReader implements Read and can be used like any other stream, but the data returned by Read are untouched bytes from the socket. This means that if a string is expected back, it could be in a different encoding than the expected one. In order to properly read text, use the charsets feature and the text or text_reader methods.

In general it’s best to avoid Reading directly from this object. Instead use the helper methods, they process the data stream properly.

Implementations

impl ResponseReader

pub fn write_to<W>(self, writer: W) -> Result<u64>where
    W: Write,

Write the response to any object that implements Write.

pub fn bytes(self) -> Result<Vec<u8>>

Read the response to a Vec of bytes.

pub fn text(self) -> Result<String>

Read the response to a String.

If the charsets feature is enabled, it will try to decode the response using the encoding in the headers. If there’s no encoding specified in the headers, it will fall back to the default encoding, and if that’s also not specified, it will fall back to the default of ISO-8859-1.

If the charsets feature is disabled, this method is the same as calling text_utf8.

Note that both conversions are lossy, i.e. they will not raise errors when invalid data is encountered but output replacement characters instead.

pub fn text_with(self, charset: Charset) -> Result<String>

Read the response to a String, decoding with the given Charset.

This will ignore the encoding from the response headers and the default encoding, if any.

This method only exists when the charsets feature is enabled.

pub fn text_reader(self) -> TextReader<BufReader<ResponseReader>>

Create a TextReader from this ResponseReader.

If the response headers contain charset information, that charset will be used to decode the body. Otherwise, if a default encoding is set it will be used. If there is no default encoding, ISO-8859-1 will be used.

This method only exists when the charsets feature is enabled.

pub fn text_reader_with(
    self,
    charset: Charset
) -> TextReader<BufReader<ResponseReader>>

Create a TextReader from this ResponseReader, decoding with the given Charset.

This will ignore the encoding from the response headers and the default encoding, if any.

This method only exists when the charsets feature is enabled.

pub fn text_utf8(self) -> Result<String>

Read the response body to a String using the UTF-8 encoding.

This method ignores headers and the default encoding.

Note that this is lossy, i.e. it will not raise errors when invalid data is encountered but output replacement characters instead.

pub fn json<T>(self) -> Result<T>where
    T: DeserializeOwned,

Parse the response as a JSON object and return it.

If the charsets feature is enabled, it will try to decode the response using the encoding in the headers. If there’s no encoding specified in the headers, it will fall back to the default encoding, and if that’s also not specified, it will fall back to the default of ISO-8859-1.

If the charsets feature is disabled, this method is the same as calling json_utf8.

pub fn json_utf8<T>(self) -> Result<T>where
    T: DeserializeOwned,

Parse the response as a JSON object encoded in UTF-8.

This method ignores headers and the default encoding.

This method only exists when the json feature is enabled.

Trait Implementations

impl Debug for ResponseReader

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

Formats the value using the given formatter.

impl Read for ResponseReader

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, Global>) -> Result<usize, Error>

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

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

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

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

Read 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)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    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.