Struct attohttpc::ResponseReader
source · [−]pub struct ResponseReader { /* private fields */ }
Expand description
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 Read
ing directly from this object. Instead use the
helper methods, they process the data stream properly.
Implementations
sourceimpl ResponseReader
impl ResponseReader
sourcepub fn write_to<W>(self, writer: W) -> Result<u64>where
W: Write,
pub fn write_to<W>(self, writer: W) -> Result<u64>where
W: Write,
Write the response to any object that implements Write
.
sourcepub fn text(self) -> Result<String>
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.
sourcepub fn text_with(self, charset: Charset) -> Result<String>
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.
sourcepub fn text_reader(self) -> TextReader<BufReader<ResponseReader>>ⓘNotable traits for TextReader<R>impl<R> Read for TextReader<R>where
R: Read,
pub fn text_reader(self) -> TextReader<BufReader<ResponseReader>>ⓘNotable traits for TextReader<R>impl<R> Read for TextReader<R>where
R: Read,
R: Read,
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.
sourcepub fn text_reader_with(
self,
charset: Charset
) -> TextReader<BufReader<ResponseReader>>ⓘNotable traits for TextReader<R>impl<R> Read for TextReader<R>where
R: Read,
pub fn text_reader_with(
self,
charset: Charset
) -> TextReader<BufReader<ResponseReader>>ⓘNotable traits for TextReader<R>impl<R> Read for TextReader<R>where
R: Read,
R: Read,
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.
sourcepub fn text_utf8(self) -> Result<String>
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.
sourcepub fn json<T>(self) -> Result<T>where
T: DeserializeOwned,
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
.
sourcepub fn json_utf8<T>(self) -> Result<T>where
T: DeserializeOwned,
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
sourceimpl Debug for ResponseReader
impl Debug for ResponseReader
sourceimpl Read for ResponseReader
impl Read for ResponseReader
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Read
. Read more