Struct base64::alphabet::Alphabet

pub struct Alphabet { /* fields omitted */ }

An alphabet defines the 64 ASCII characters (symbols) used for base64.

Common alphabets are provided as constants, and custom alphabets can be made via from_str or the TryFrom<str> implementation.

let custom = base64::alphabet::Alphabet::from_str("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/").unwrap();

let engine = base64::engine::fast_portable::FastPortable::from(
    &custom,
    base64::engine::fast_portable::PAD);

Implementations

impl Alphabet

pub const fn from_str(alphabet: &str) -> Result<Self, ParseAlphabetError>

Create an Alphabet from a string of 64 unique printable ASCII bytes.

The = byte is not allowed as it is used for padding.

The const-ness of this function isn’t useful as of rust 1.54.0 since const unwrap(), etc, haven’t shipped yet, but that’s on the roadmap.

Trait Implementations

impl Clone for Alphabet

fn clone(&self) -> Alphabet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Alphabet

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

Formats the value using the given formatter.

impl PartialEq<Alphabet> for Alphabet

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<&'_ str> for Alphabet

type Error = ParseAlphabetError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Alphabet

impl StructuralEq for Alphabet

impl StructuralPartialEq for Alphabet