Struct ulid::Ulid

pub struct Ulid(pub u128);

A Ulid is a unique 128-bit lexicographically sortable identifier

Canonically, it is represented as a 26 character Crockford Base32 encoded string.

Of the 128-bits, the first 48 are a unix timestamp in milliseconds. The remaining 80 are random. The first 48 provide for lexicographic sorting and the remaining 80 ensure that the identifier is unique.

Tuple Fields

0: u128

Implementations

impl Ulid

pub fn new() -> Ulid

Creates a new Ulid with the current time

pub fn with_source<R: Rng>(source: &mut R) -> Ulid

Creates a new Ulid using data from the given random number generator

pub fn from_datetime<T: TimeZone>(datetime: DateTime<T>) -> Ulid

Creates a new Ulid with the given datetime

This can be useful when migrating data to use Ulid identifiers

pub fn from_datetime_with_source<T, R>(
    datetime: DateTime<T>,
    source: &mut R
) -> Ulidwhere
    T: TimeZone,
    R: Rng,

Creates a new Ulid with the given datetime and random number generator

pub fn from_string(encoded: &str) -> Result<Ulid, EncodingError>

Creates a Ulid from a Crockford Base32 encoded string

An EncodingError will be returned when the given string is not formated properly.

pub fn datetime(&self) -> DateTime<Utc>

Gets the datetime of when this Ulid was created accurate to 1ms

pub fn timestamp_ms(&self) -> u64

Gets the timestamp section of this ulid

pub fn to_string(&self) -> String

Creates a Crockford Base32 encoded string that represents this Ulid

Trait Implementations

impl Clone for Ulid

fn clone(&self) -> Ulid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ulid

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

Formats the value using the given formatter.

impl Display for Ulid

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

Formats the value using the given formatter.

impl From<(u64, u64)> for Ulid

fn from((msb, lsb): (u64, u64)) -> Self

Converts to this type from the input type.

impl From<u128> for Ulid

fn from(value: u128) -> Ulid

Converts to this type from the input type.

impl Into<(u64, u64)> for Ulid

fn into(self) -> (u64, u64)

Converts this type into the (usually inferred) input type.

impl<'a> Into<String> for &'a Ulid

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl Into<u128> for Ulid

fn into(self) -> u128

Converts this type into the (usually inferred) input type.

impl PartialEq<Ulid> for Ulid

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Ulid> for Ulid

fn partial_cmp(&self, other: &Ulid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Ulid

impl StructuralPartialEq for Ulid