Struct Encoder 

pub struct Encoder { /* private fields */ }

Stateful standard basE91 encoder.

A call to finish ends the current message and consumes the encoder, so the same stream cannot be continued afterwards. Separately finished messages must not be concatenated and treated as one basE91 stream.

The consuming contract is enforced by the type system: the encoder is not Copy, so reusing it after finish fails to compile.

use fastbase91_core::Encoder;
let mut encoder = Encoder::new();
let mut output = [0_u8; 4];
let _tail = encoder.finish();
// `finish` consumed the encoder; encoding more must not compile.
let _ = encoder.update(b"x", &mut output);

Implementations

impl Encoder

pub const fn new() -> Self

Creates an empty encoder.

pub fn update( &mut self, input: &[u8], output: &mut [u8], ) -> Result<usize, OutputTooSmall>

Encodes a chunk into caller-provided storage.

If the output is too small, neither the encoder state nor the output slice is changed. Capacity is checked using a content-independent upper bound derived from the current bit count and the input length.

pub fn finish(self) -> ([u8; 2], usize)

Returns the final encoded tail and its length.

Trait Implementations

impl Clone for Encoder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Encoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Encoder

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Encoder

impl PartialEq for Encoder

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Encoder