Struct base64ct::Decoder

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

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§

source§

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

source

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.
source

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.
source

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
source

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.

source

pub fn remaining_len(&self) -> usize

Get the length of the remaining data after Base64 decoding.

Decreases every time data is decoded.

source

pub fn is_finished(&self) -> bool

Has all of the input data been decoded?

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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. Read more
source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

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

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

Read the exact number of bytes required to fill buf. Read more
1.36.0 · source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
source§

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. Read more
1.0.0 · source§

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

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

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. Read more
source§

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. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations§

§

impl<'i, E> RefUnwindSafe for Decoder<'i, E>
where E: RefUnwindSafe,

§

impl<'i, E> Send for Decoder<'i, E>

§

impl<'i, E> Sync for Decoder<'i, E>

§

impl<'i, E> Unpin for Decoder<'i, E>
where E: Unpin,

§

impl<'i, E> UnwindSafe for Decoder<'i, E>
where E: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.