Enum Decoder

#[non_exhaustive]
pub enum Decoder {
    Hex,
    Base64,
    Base64Url,
    Custom(Encoding),
}

Decoder of a human-friendly encoding, such as hex or base64, into bytes.

Examples

See the crate docs for examples of usage.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Hex

Hexadecimal decoder. Supports uppercase and lowercase digits.

Base64

Base64 decoder accepting standard encoding as per RFC 3548. Does not require padding, but works fine with it.

Base64Url

Base64 decoder accepting URL / filesystem-safe encoding as per RFC 3548. Does not require padding, but works fine with it.

Custom(Encoding)

Decoder based on a custom Encoding.

Implementations

impl Decoder

pub const fn custom(alphabet: &'static str) -> Self

Creates a new decoder with a custom alphabet.

Panics

Panics in the same situations as Encoding::new().

pub const fn skip_whitespace(self) -> SkipWhitespace

Makes this decoder skip whitespace chars rather than panicking on encountering them.

pub const fn decode<const N: usize>(self, input: &[u8]) -> [u8; N]

Decodes input into a byte array.

Panics

• Panics if the provided length is insufficient or too large for input.
• Panics if input contains invalid chars.

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Decoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decoder

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

Formats the value using the given formatter.

impl Copy for Decoder