Struct Alphabet 

pub struct Alphabet { /* private fields */ }

The characters an ID is written with, one per digit.

The number of characters is the base: BASE62 writes IDs in base 62. Give an ID type an alphabet with the alphabet option of #[typedflake] to get encode and decode:

use typedflake::{Alphabet, typedflake};

// Digits and lowercase letters, without the easily confused `0`, `1`, `i`, `l`, and `o`.
pub const FRIENDLY: Alphabet = Alphabet::new("23456789abcdefghjkmnpqrstuvwxyz");

#[typedflake(epoch = "2025-01-01", alphabet = FRIENDLY)]
pub struct InviteId(i64);

let id = InviteId::try_from(232_900_560_974_681_078_i64)?;
let text = id.encode();

assert_eq!(text.as_str(), "2b76swcw35egs");
assert_eq!(InviteId::decode(&text)?, id);

Every ID of a type encodes to the same number of characters. When the alphabet lists its characters in ascending ASCII order, as the presets do, encoded IDs sort the same way the IDs do.

Implementations

impl Alphabet

pub const BASE36: Self

Digits, then lowercase letters.

pub const BASE58: Self

The Bitcoin alphabet: no 0, O, I, or l.

pub const BASE62: Self

Digits, uppercase letters, then lowercase letters.

pub const BASE64_URL: Self

The 64 URL-safe characters of base64url, in ascending ASCII order so that encoded IDs stay sortable.

This is not the base64 encoding of the ID’s bytes, and a base64 decoder will not read it. Its zero digit is -, so encoded IDs can start with a hyphen.

pub const fn new(chars: &str) -> Self

Creates an alphabet from its characters, in digit order: the first character is zero.

Panics

Panics unless chars holds between 2 and 94 distinct printable ASCII characters, without spaces. In a const context this is a compile-time error.

pub fn as_str(&self) -> &str

The characters, in digit order.

Trait Implementations

impl Clone for Alphabet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Alphabet

impl Debug for Alphabet

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

Formats the value using the given formatter.

impl Eq for Alphabet

impl PartialEq for Alphabet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Alphabet