Struct ULID 

pub struct ULID { /* private fields */ }

Available on crate feature ulid only.

A 128-bit ULID

• 0 bits reserved
• 48 bits timestamp
• 80 bits random

 Bit Index:  127            80 79           0
             +----------------+-------------+
 Field:      | timestamp (48) | random (80) |
             +----------------+-------------+
             |<-- MSB -- 128 bits -- LSB -->|

Implementations

impl ULID

pub const RESERVED_BITS: u128 = 0u128

pub const TIMESTAMP_BITS: u128 = 48u128

pub const RANDOM_BITS: u128 = 80u128

pub const RANDOM_SHIFT: u128 = 0u128

pub const TIMESTAMP_SHIFT: u128 = 80u128

pub const RESERVED_SHIFT: u128 = 128u128

pub const RESERVED_MASK: u128 = 0u128

pub const TIMESTAMP_MASK: u128 = 281_474_976_710_655u128

pub const RANDOM_MASK: u128 = 1_208_925_819_614_629_174_706_175u128

pub const fn from(timestamp: u128, random: u128) -> Self

pub const fn timestamp(&self) -> u128

Extracts the timestamp from the packed ID.

pub const fn random(&self) -> u128

Extracts the random number from the packed ID.

pub const fn max_timestamp() -> u128

Returns the maximum representable timestamp value based on Self::TIMESTAMP_BITS.

pub const fn max_random() -> u128

Returns the maximum representable randome value based on Self::RANDOM_BIT.

pub const fn to_raw(&self) -> u128

Converts this type into its raw type representation

pub const fn from_raw(raw: u128) -> Self

Converts a raw type into this type

pub fn from_timestamp(timestamp: <Self as Id>::Ty) -> Self

Available on crate feature std only.

Generates a ULID from the given timestamp in milliseconds since UNIX epoch, using the built-in ThreadRandom random generator.

pub fn from_timestamp_and_rand<R>(timestamp: <Self as Id>::Ty, rng: &R) -> Self

where R: RandSource<<Self as Id>::Ty>,

Generates a ULID from the given timestamp in milliseconds since UNIX epoch and a custom random number generator implementing RandSource

pub fn from_datetime(datetime: SystemTime) -> Self

Available on crate feature std only.

Generates a ULID from the given SystemTime, using the built-in ThreadRandom random generator.

pub fn from_datetime_and_rand<R>(datetime: SystemTime, rng: &R) -> Self

where R: RandSource<<Self as Id>::Ty>,

Available on crate feature std only.

Generates a ULID from the given SystemTime and a custom random number generator implementing RandSource

Trait Implementations

impl Clone for ULID

fn clone(&self) -> ULID

Returns a duplicate 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

Available on crate feature base32 only.

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

Formats the value using the given formatter.

impl FromStr for ULID

Available on crate feature base32 only.

type Err = Error<ULID>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ULID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Id for ULID

fn to_raw(&self) -> Self::Ty

Converts this type into its raw type representation

fn from_raw(raw: Self::Ty) -> Self

Converts a raw type into this type

const ZERO: u128 = 0u128

Zero value (used for resetting the sequence)

const ONE: u128 = 1u128

One value (used for incrementing the sequence)

type Ty = u128

Scalar type for all bit fields (typically u64 or u128)

impl Ord for ULID

fn cmp(&self, other: &ULID) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ULID

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&str> for ULID

Available on crate feature base32 only.

type Error = Error<ULID>

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl UlidId for ULID

fn timestamp(&self) -> Self::Ty

Returns the timestamp portion of the ID.

fn random(&self) -> Self::Ty

Returns the random portion of the ID.

fn max_timestamp() -> Self::Ty

Returns the maximum possible value for the timestamp field.

fn max_random() -> Self::Ty

Returns the maximum possible value for the random field.

fn from_components(timestamp: u128, random: u128) -> Self

Constructs a new ULID from its components.

fn is_valid(&self) -> bool

Returns true if the ID’s internal structure is valid, such as reserved bits being unset or fields within expected ranges.

fn into_valid(self) -> Self

Returns a normalized version of the ID with any invalid or reserved bits cleared. This guarantees a valid, canonical representation.

fn has_random_room(&self) -> bool

Returns true if the current sequence value can be incremented.

fn next_random(&self) -> Self::Ty

Returns the next sequence value.

fn increment_random(&self) -> Self

Returns a new ID with the random portion incremented.

fn rollover_to_timestamp(&self, ts: Self::Ty, rand: Self::Ty) -> Self

Returns a new ID for a newer timestamp with sequence reset to zero.

impl Copy for ULID

impl Eq for ULID

impl StructuralPartialEq for ULID