Skip to main content

Decoder

Struct Decoder 

Source
pub struct Decoder { /* private fields */ }
Expand description

Stateful standard basE91 decoder.

A call to finish ends the current message and consumes the decoder, so the same stream cannot be continued afterwards. The consuming contract is enforced by the type system: the decoder is not Copy, so reusing it after finish fails to compile.

ⓘ
use fastbase91_core::{DecodeOptions, Decoder};
let mut decoder = Decoder::new(DecodeOptions::new());
let mut output = [0_u8; 4];
let _tail = decoder.finish();
// `finish` consumed the decoder; decoding more must not compile.
let _ = decoder.update(b"AA", &mut output);

Implementations§

Source§

impl Decoder

Source

pub const fn new(options: DecodeOptions) -> Self

Creates a decoder with the requested policy.

Source

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

Decodes a chunk into caller-provided storage.

Capacity is checked first using a content-independent upper bound; on OutputTooSmall neither the decoder state nor the output is changed. In strict mode the first byte outside the alphabet stops decoding with InvalidByte, whose offset is the 0-based index of that byte within this input; the decoder state is left unchanged, but bytes already written to output are unspecified and must be discarded.

Source

pub fn finish(self) -> Result<Option<u8>, DecodeError>

Returns the final decoded byte, if an unpaired symbol remains.

Trait Implementations§

Source§

impl Clone for Decoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Decoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Decoder

Source§

impl PartialEq for Decoder

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Decoder

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.