Trait nid::alphabet::Alphabet

pub trait Alphabet {
    const SYMBOL_LIST: &'static [u8];
}

A set of symbols that can be used in Nano ID. In this crate, only ASCII characters can be used as symbols.

For the list of available alphabets, see the alphabet module.

Implementing a custom alphabet

To implement a custom alphabet, you need to create a new type that implements the Alphabet trait.

use nid::{alphabet::Alphabet, Nanoid};

struct CustomAlphabet;

impl Alphabet for CustomAlphabet {
    const SYMBOL_LIST: &'static [u8] = b"(){}[]<>";
}

let id: Nanoid<21, CustomAlphabet> = Nanoid::new();
let id: Nanoid<21, CustomAlphabet> = "{{)((})>]<)}(>)(<)<){".parse()?;

Note that the alphabet must contain only ASCII characters. If you use an alphabet with non-ASCII characters, the compilation error will occur.

use nid::{alphabet::Alphabet, Nanoid};

struct CustomAlphabet;

impl Alphabet for CustomAlphabet {
    const SYMBOL_LIST: &'static [u8] = b"abc012\xa0\xa1";
}

let id: Nanoid<21, CustomAlphabet> = Nanoid::new(); // Compilation error: found non-ascii symbol in alphabet

Required Associated Constants

const SYMBOL_LIST: &'static [u8]

The symbols that can be used in Nano ID. Symbols are represented as u8 values.

Object Safety

This trait is not object safe.

Implementors

impl Alphabet for Base16Alphabet

const SYMBOL_LIST: &'static [u8] = b"ABCDEF0123456789"

impl Alphabet for Base16LowercaseAlphabet

const SYMBOL_LIST: &'static [u8] = b"abcdef0123456789"

impl Alphabet for Base32Alphabet

const SYMBOL_LIST: &'static [u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"

impl Alphabet for Base32LowercaseAlphabet

const SYMBOL_LIST: &'static [u8] = b"abcdefghijklmnopqrstuvwxyz234567"

impl Alphabet for Base36Alphabet

const SYMBOL_LIST: &'static [u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

impl Alphabet for Base36LowercaseAlphabet

const SYMBOL_LIST: &'static [u8] = b"abcdefghijklmnopqrstuvwxyz0123456789"

impl Alphabet for Base58Alphabet

const SYMBOL_LIST: &'static [u8] = b"ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz123456789"

impl Alphabet for Base62Alphabet

const SYMBOL_LIST: &'static [u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"

impl Alphabet for Base64UrlAlphabet

const SYMBOL_LIST: &'static [u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"