Struct EncoderWriter 

pub struct EncoderWriter<W, A, const PAD: bool>
where
    A: Alphabet,
{ /* private fields */ }

Async writer that accepts raw bytes and writes Base64 to the wrapped writer.

poll_write may accept only part of the input, following normal AsyncWrite rules. Accepted bytes may remain buffered internally until a later write, AsyncWrite::poll_flush, or AsyncWrite::poll_shutdown. Shutdown is the finalization boundary: it encodes any trailing partial quantum, drains all buffered output, flushes, and then shuts down inner.

Security

Internal cleanup is best-effort and limited to this adapter’s fixed pending and output buffers. It cannot clear copies held by the wrapped writer, the caller’s buffers, registers, caches, swap, or crash dumps.

I/O errors from the wrapped writer during drain do not set Self::is_failed; only internal protocol or capacity violations latch a permanent failure.

Implementations

impl<W, A, const PAD: bool> EncoderWriter<W, A, PAD>

where A: Alphabet,

pub fn new(inner: W, engine: Engine<A, PAD>) -> Self

Creates a new async Base64 encoder writer.

pub fn get_ref(&self) -> &W

Returns a shared reference to the wrapped writer.

pub fn get_mut(&mut self) -> &mut W

Returns a mutable reference to the wrapped writer.

pub fn into_inner(self) -> W

Consumes the adapter and returns the wrapped writer.

This does not finalize pending input. Prefer AsyncWriteExt::shutdown before calling this when the Base64 stream must be complete.

pub const fn is_failed(&self) -> bool

Returns whether this adapter has encountered an unrecoverable error.

pub const fn is_finalized(&self) -> bool

Returns whether shutdown has finalized this adapter.

pub const fn pending_len(&self) -> usize

Returns the number of raw bytes buffered until a full encode quantum is available.

pub const fn buffered_output_len(&self) -> usize

Returns the number of encoded bytes currently buffered for inner.

Trait Implementations

impl<W, A, const PAD: bool> AsyncWrite for EncoderWriter<W, A, PAD>

where W: AsyncWrite + Unpin, A: Alphabet + Unpin,

fn poll_write( self: Pin<&mut Self>, context: &mut Context<'_>, input: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, context: &mut Context<'_>, ) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, context: &mut Context<'_>, ) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W, A, const PAD: bool> Drop for EncoderWriter<W, A, PAD>

where A: Alphabet,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.