[−][src]Struct encoding_rs_io::DecodeReaderBytes
An implementation of io::Read
that transcodes to UTF-8 in a streaming
fashion.
The high level goal of this decoder is to provide access to byte streams that are assumed to be UTF-8 unless an encoding is otherwise specified (either via a BOM or via an explicit designation of an encoding).
When no explicit source encoding is specified (via
DecodeReaderBytesBuilder
), the source encoding is determined by
inspecting the BOM from the stream read from R
, if one exists. If a
UTF-16 BOM exists, then the source stream is transcoded to UTF-8 with
invalid UTF-16 sequences translated to the Unicode replacement character.
Similarly if a UTF-8 BOM is seen. In all other cases, the source of the
underlying reader is passed through unchanged as if it were UTF-8.
Since this particular reader does not guarantee providing valid UTF-8 to the caller, the caller must be prepared to handle invalid UTF-8 itself.
R
is the type of the underlying reader and B
is the type of an internal
buffer used to store the results of transcoding. Callers may elect to reuse
the internal buffer via the DecodeReaderBytesBuilder::build_with_buffer
constructor.
Methods
impl<R: Read> DecodeReaderBytes<R, Vec<u8>>
[src]
ⓘImportant traits for DecodeReaderBytes<R, B>pub fn new(rdr: R) -> DecodeReaderBytes<R, Vec<u8>>
[src]
Create a new transcoder that converts a source stream to valid UTF-8 via BOM sniffing.
To explicitly control the encoding, UTF-8 passthru or amortize
allocation, use the
DecodeReaderBytesBuilder
constructor.
When a BOM is found (which must correspond to UTF-8, UTF-16LE or UTF-16BE), then transcoding to UTF-8 is performed and any invalid sequences in the source data are seamlessly replaced by the Unicode replacement character.
When no BOM is found (and no other encoding is specified via the builder), the underlying bytes are passed through as-is.
Trait Implementations
impl<R: Debug, B: Debug> Debug for DecodeReaderBytes<R, B>
[src]
impl<R: Read, B: AsMut<[u8]>> Read for DecodeReaderBytes<R, B>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Auto Trait Implementations
impl<R, B> RefUnwindSafe for DecodeReaderBytes<R, B> where
B: RefUnwindSafe,
R: RefUnwindSafe,
B: RefUnwindSafe,
R: RefUnwindSafe,
impl<R, B> Send for DecodeReaderBytes<R, B> where
B: Send,
R: Send,
B: Send,
R: Send,
impl<R, B> Sync for DecodeReaderBytes<R, B> where
B: Sync,
R: Sync,
B: Sync,
R: Sync,
impl<R, B> Unpin for DecodeReaderBytes<R, B> where
B: Unpin,
R: Unpin,
B: Unpin,
R: Unpin,
impl<R, B> UnwindSafe for DecodeReaderBytes<R, B> where
B: UnwindSafe,
R: UnwindSafe,
B: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,