Struct Decoder

pub struct Decoder<'i, E: Encoding> { /* private fields */ }

Stateful Base64 decoder with support for buffered, incremental decoding.

The E type parameter can be any type which impls Encoding such as Base64 or Base64Unpadded.

Implementations

impl<'i, E: Encoding> Decoder<'i, E>

pub fn new(input: &'i [u8]) -> Result<Self, Error>

Create a new decoder for a byte slice containing contiguous (non-newline-delimited) Base64-encoded data.

Returns

• Ok(decoder) on success.
• Err(Error::InvalidLength) if the input buffer is empty.

pub fn new_wrapped(input: &'i [u8], line_width: usize) -> Result<Self, Error>

Create a new decoder for a byte slice containing Base64 which line wraps at the given line length.

Trailing newlines are not supported and must be removed in advance.

Newlines are handled according to what are roughly RFC7468 conventions:

[parsers] MUST handle different newline conventions

RFC7468 allows any of the following as newlines, and allows a mixture of different types of newlines:

eol        = CRLF / CR / LF

Returns

• Ok(decoder) on success.
• Err(Error::InvalidLength) if the input buffer is empty or the line width is zero.

pub fn decode<'o>(&mut self, out: &'o mut [u8]) -> Result<&'o [u8], Error>

Fill the provided buffer with data decoded from Base64.

Enough Base64 input data must remain to fill the entire buffer.

Returns

• Ok(bytes) if the expected amount of data was read
• Err(Error::InvalidLength) if the exact amount of data couldn’t be read

pub fn decode_to_end<'o>( &mut self, buf: &'o mut Vec<u8>, ) -> Result<&'o [u8], Error>

Decode all remaining Base64 data, placing the result into buf.

If successful, this function will return the total number of bytes decoded into buf.

pub fn remaining_len(&self) -> usize

Get the length of the remaining data after Base64 decoding.

Decreases every time data is decoded.

pub fn is_finished(&self) -> bool

Has all of the input data been decoded?

Trait Implementations

impl<'i, E: Clone + Encoding> Clone for Decoder<'i, E>

fn clone(&self) -> Decoder<'i, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'i, E: Encoding> Read for Decoder<'i, E>

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_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

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

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

Reads the exact number of bytes required to fill buf.

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_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to 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.