Struct cuid2::CuidConstructor

pub struct CuidConstructor { /* private fields */ }

Provides customization of CUID generation.

use cuid2::CuidConstructor;

let mut constructor = CuidConstructor::new();
assert_eq!(24, constructor.create_id().len());

constructor.set_length(16);
assert_eq!(16, constructor.create_id().len());

assert_eq!(32, CuidConstructor::new().with_length(32).create_id().len());

Implementations

impl CuidConstructor

pub const fn new() -> Self

Creates a new constructor with default settings.

pub const fn with_length(self, length: u16) -> Self

Returns a new constructor that will generate CUIDs with the specified length.

Panics

Panics if length is less than 2.

pub const fn with_counter(self, counter: fn() -> u64) -> Self

Returns a new constructor with the specified counter function.

pub const fn with_fingerprinter(self, fingerprinter: fn() -> String) -> Self

Returns a new constructor with the specified fingerprinter function.

pub fn set_length(&mut self, length: u16)

Sets the length for CUIDs generated by this constrctor.

Panics

Panics if length is less than 2.

pub fn set_counter(&mut self, counter: fn() -> u64)

Sets the counter function for this constructor.

pub fn set_fingerprinter(&mut self, fingerprinter: fn() -> String)

Sets the fingerperinter function for this constructor.

pub fn create_id(&self) -> String

Creates a new CUID.

Trait Implementations

impl Default for CuidConstructor

fn default() -> Self

Returns the “default value” for a type.