Struct oysterpack_uid::ulid::TypedULID

pub struct TypedULID<T: 'static + ?Sized> { /* private fields */ }

A TypedULID represents a domain specific ULID, where the domain is defined and enforced by the type system.

How to define a TypedULID for structs

struct Foo;
type FooId = TypedULID<Foo>;
let id = FooId::generate();

How to define TypedULID for traits

trait Foo{}
// traits are not Send. Send is added to the type def in order to satisfy TypedULID type constraints
// in order to be able to send the TypedULID across threads
type FooId = TypedULID<dyn Foo + Send + Sync>;
let id = FooId::generate();

TypedULID<T> can be converted to a DomainULID automatically if the TypedULID type T implements HasDomain.

struct Foo;

impl HasDomain for Foo {
    const DOMAIN: Domain = Domain("Foo");
}

type FooId = TypedULID<Foo>;
let id = FooId::generate();
let id: DomainULID = id.into();
assert_eq!(id.domain(), Foo::DOMAIN.name());

Implementations

impl<T: 'static + ?Sized> TypedULID<T>

pub fn generate() -> TypedULID<T>

New TypedULID instances are guaranteed to be lexographically sortable if they are created within the same millisecond. In other words, TypedULID(s) created within the same millisecond are random.

pub fn next(previous: TypedULID<T>) -> Option<TypedULID<T>>

Creates the next strictly monotonic ULID for the given previous ULID. Returns None if the random part of the next ULID would overflow.

pub fn ulid(&self) -> ULID

returns the ulid

pub fn increment(self) -> Option<TypedULID<T>>

Returns a new ULID with the random part incremented by one. Returns None if the new ULID overflows.

Trait Implementations

impl<T: 'static + ?Sized> Clone for TypedULID<T>

fn clone(&self) -> TypedULID<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: 'static + ?Sized> Debug for TypedULID<T>

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

Formats the value using the given formatter.

impl<'de, T: 'static> Deserialize<'de> for TypedULID<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: 'static + ?Sized> Display for TypedULID<T>

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

Formats the value using the given formatter.

impl<T: 'static + ?Sized> From<[u8; 16]> for TypedULID<T>

fn from(bytes: [u8; 16]) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> From<(u64, u64)> for TypedULID<T>

fn from(id: (u64, u64)) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> From<TypedULID<T>> for (u64, u64)

fn from(ulid: TypedULID<T>) -> Self

Converts to this type from the input type.

impl<T: HasDomain> From<TypedULID<T>> for DomainULID

fn from(uid: TypedULID<T>) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> From<TypedULID<T>> for ULID

fn from(ulid: TypedULID<T>) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> From<TypedULID<T>> for u128

fn from(ulid: TypedULID<T>) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> From<ULID> for TypedULID<T>

fn from(id: ULID) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> From<u128> for TypedULID<T>

fn from(id: u128) -> Self

Converts to this type from the input type.

impl<T: 'static + ?Sized> FromStr for TypedULID<T>

type Err = DecodingError

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<T: 'static + ?Sized> Hash for TypedULID<T>

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<T: 'static + ?Sized> Ord for TypedULID<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: 'static + ?Sized> PartialEq<TypedULID<T>> for TypedULID<T>

fn eq(&self, other: &TypedULID<T>) -> 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<T: 'static + ?Sized> PartialOrd<TypedULID<T>> for TypedULID<T>

fn partial_cmp(&self, other: &TypedULID<T>) -> 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<T: 'static> Serialize for TypedULID<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: 'static + ?Sized> Copy for TypedULID<T>

impl<T: 'static + ?Sized> Eq for TypedULID<T>