Struct ulid_generator_rs::ULIDGenerator

pub struct ULIDGenerator { /* fields omitted */ }

This is the ULID Generator.

Implementations

impl ULIDGenerator

#[must_use]pub fn new() -> Self

The Constructor for ULIDGenerator.

pub fn generate(&mut self) -> Result<ULID, ULIDError>

Generate a ULID.

Generate a ULID based on the current time.

Example

use ulid_generator_rs::ULIDGenerator;

let mut generator = ULIDGenerator::new();
let ulid = generator.generate().unwrap();

pub fn generate_monotonic(
    &mut self,
    previous_id: &ULID
) -> Result<ULID, ULIDError>

Generate a monotonic ULID.

Generate a ULID based on the current time, but if the current is the same timestamp as the previous_id, the lower 64 bits are incremented.

Example

use ulid_generator_rs::ULIDGenerator;

let mut generator = ULIDGenerator::new();
let previous_id = generator.generate().unwrap();
let ulid = generator.generate_monotonic(&previous_id).unwrap();

pub fn generate_strictly_monotonic(
    &mut self,
    previous_id: &ULID
) -> Result<Option<ULID>, ULIDError>

Generate a strictly monotonic ULID.

If the ULID generated by ULIDGenerator::generate_monotonic is smaller than previous_id, None is returned. Otherwise, the ULID will be returned wrapped in Some.

Example

use ulid_generator_rs::ULIDGenerator;

let mut generator = ULIDGenerator::new();
let prev_id = generator.generate().unwrap();
let ulid = generator.generate_monotonic(&prev_id).unwrap();

Trait Implementations

impl Clone for ULIDGenerator

pub fn clone(&self) -> ULIDGenerator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ULIDGenerator

impl Debug for ULIDGenerator

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

Formats the value using the given formatter.

impl Default for ULIDGenerator

pub fn default() -> Self

Returns the "default value" for a type.