Struct base64ct::Encoder

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

Stateful Base64 encoder with support for buffered, incremental encoding.

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

Implementations§

source§

impl<'o, E: Encoding> Encoder<'o, E>

source

pub fn new(output: &'o mut [u8]) -> Result<Self, Error>

Create a new encoder which writes output to the given byte slice.

Output constructed using this method is not line-wrapped.

source

pub fn new_wrapped( output: &'o mut [u8], width: usize, ending: LineEnding ) -> Result<Self, Error>

Create a new encoder which writes line-wrapped output to the given byte slice.

Output will be wrapped at the specified interval, using the provided line ending. Use LineEnding::default() to use the conventional line ending for the target OS.

Minimum allowed line width is 4.

source

pub fn encode(&mut self, input: &[u8]) -> Result<(), Error>

Encode the provided buffer as Base64, writing it to the output buffer.

§Returns
  • Ok(bytes) if the expected amount of data was read
  • Err(Error::InvalidLength) if there is insufficient space in the output buffer
source

pub fn position(&self) -> usize

Get the position inside of the output buffer where the write cursor is currently located.

source

pub fn finish(self) -> Result<&'o str, Error>

Finish encoding data, returning the resulting Base64 as a str.

source

pub fn finish_with_remaining(self) -> Result<(&'o str, &'o mut [u8]), Error>

Finish encoding data, returning the resulting Base64 as a str along with the remaining space in the output buffer.

Trait Implementations§

source§

impl<'o, E: Encoding> Write for Encoder<'o, E>

source§

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

Write a buffer into this writer, returning how many bytes were written. Read more
source§

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · source§

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

Like write, except that it writes from a slice of buffers. Read more
source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · source§

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

Attempts to write an entire buffer into this writer. Read more
source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

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

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<'o, E> RefUnwindSafe for Encoder<'o, E>
where E: RefUnwindSafe,

§

impl<'o, E> Send for Encoder<'o, E>

§

impl<'o, E> Sync for Encoder<'o, E>

§

impl<'o, E> Unpin for Encoder<'o, E>
where E: Unpin,

§

impl<'o, E> !UnwindSafe for Encoder<'o, E>

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