Enum IdGenerator 

#[non_exhaustive]
pub enum IdGenerator {
    UuidV7,
    UuidV4,
    Short(ShortId),
    Custom(Arc<dyn Fn() -> String + Sync + Send>),
    Fallible(Arc<dyn Fn() -> Result<String, VantageError> + Sync + Send>),
}

How a missing id is minted when a new record is inserted.

UuidV7 is the default: it is time-ordered (RFC 9562), so ids sort by creation time and cluster together in a primary-key index instead of scattering it the way the purely-random UuidV4 does.

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.

UuidV7

Time-ordered UUID (v7).

UuidV4

Random UUID (v4).

Short(ShortId)

A short random id: length characters drawn uniformly from an alphabet. See ShortId.

Custom(Arc<dyn Fn() -> String + Sync + Send>)

Any caller-supplied scheme (ULID, nanoid, a counter, …).

Fallible(Arc<dyn Fn() -> Result<String, VantageError> + Sync + Send>)

A caller-supplied scheme that can fail (a compiled script). The write that asked for the id fails with its error.

Implementations

impl IdGenerator

pub fn custom(f: impl Fn() -> String + Send + Sync + 'static) -> IdGenerator

A custom generator from a closure.

pub fn fallible( f: impl Fn() -> Result<String, VantageError> + Send + Sync + 'static, ) -> IdGenerator

A generator from a closure that can fail; see try_generate.

pub fn short(length: usize, alphabet: &str) -> Result<IdGenerator, VantageError>

A short id of length characters from alphabet; see ShortId::new.

pub fn try_generate(&self) -> Result<String, VantageError>

One fresh id, or the error of a Fallible generator. Writers mint through this.

pub fn generate(&self) -> String

One fresh id.

Panics

When a Fallible generator fails; use try_generate for those.

Trait Implementations

impl Clone for IdGenerator

fn clone(&self) -> IdGenerator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdGenerator

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

Formats the value using the given formatter.

impl Default for IdGenerator

fn default() -> IdGenerator

Returns the “default value” for a type.