GenericId

Struct GenericId 

Source
pub struct GenericId<T: IdCategory> { /* private fields */ }
Expand description

Generic identifier value object for domain entities

§Purpose

Provides the foundational ID implementation that all specific entity IDs build upon. This generic approach ensures consistency while allowing type-safe specialization.

§Design Principles

  • Type Safety: Each entity gets its own distinct ID type
  • Validation: Consistent validation rules across all ID types
  • Serialization: Uniform JSON/database representation
  • Cross-Language: Clear specification for Go implementation

§Architecture Notes

This is the base implementation that specific ID value objects compose. It should not be used directly - instead use the specific ID types like PipelineId, StageId, etc.

§Cross-Language Mapping

  • Rust: GenericId<T> with phantom type parameter
  • Go: GenericID[T any] with type parameter
  • JSON: String representation of ULID
  • SQLite: TEXT column with ULID string
  • Time-Ordered: Natural chronological sorting

Implementations§

Source§

impl<T: IdCategory> GenericId<T>

Source

pub fn new() -> Self

Creates a new time-ordered entity ID with category validation

§Time Ordering

ULIDs are naturally sorted by creation time, making them perfect for:

  • Database indexes (sequential inserts)
  • Event ordering
  • Chronological queries
  • Debugging (time-based ID inspection)
Source

pub fn from_ulid(ulid: Ulid) -> Result<Self, PipelineError>

Creates an entity ID from an existing ULID with validation

Source

pub fn from_timestamp_ms(timestamp_ms: u64) -> Result<Self, PipelineError>

Creates an entity ID from a timestamp (useful for range queries)

§Use Cases
  • Creating boundary IDs for time-range queries
  • Testing with specific timestamps
  • Migration scenarios requiring specific timestamp IDs
Source

pub fn from_string(s: &str) -> Result<Self, PipelineError>

Creates an entity ID from a string representation

§Format

Accepts standard ULID string format (26 characters, base32 encoded) Example: “01ARZ3NDEKTSV4RRFFQ69G5FAV”

Source

pub fn as_ulid(&self) -> Ulid

Gets the underlying ULID value

Source

pub fn timestamp_ms(&self) -> u64

Gets the timestamp component of the ULID

§Returns

Milliseconds since Unix epoch when this ID was created

§Use Cases
  • Time-range queries
  • Debugging creation times
  • Audit trails
Source

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

Gets the creation time as a DateTime

§Use Cases
  • Human-readable timestamps
  • Time-based filtering
  • Audit logs
Source

pub fn to_lowercase(&self) -> String

Converts to lowercase string representation

§Use Cases
  • Case-insensitive systems
  • URL paths
  • Database systems that prefer lowercase
Source

pub fn category(&self) -> &'static str

Gets the ID category name

Source

pub fn validate(&self) -> Result<(), PipelineError>

Validates the ID using category-specific rules

Source

pub fn is_nil(&self) -> bool

Checks if this is a nil (zero) ULID

Trait Implementations§

Source§

impl<T: IdCategory> AsRef<Ulid> for GenericId<T>

Source§

fn as_ref(&self) -> &Ulid

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<T: Clone + IdCategory> Clone for GenericId<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + IdCategory> Debug for GenericId<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: IdCategory> Default for GenericId<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, T: IdCategory> Deserialize<'de> for GenericId<T>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: IdCategory> Display for GenericId<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: IdCategory> From<GenericId<T>> for Ulid

Source§

fn from(id: GenericId<T>) -> Self

Converts to this type from the input type.
Source§

impl<T: IdCategory> From<Ulid> for GenericId<T>

Source§

fn from(ulid: Ulid) -> Self

Converts to this type from the input type.
Source§

impl<T: IdCategory> FromStr for GenericId<T>

Source§

type Err = PipelineError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl<T: IdCategory> Hash for GenericId<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: Ord + IdCategory> Ord for GenericId<T>

Source§

fn cmp(&self, other: &GenericId<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq + IdCategory> PartialEq for GenericId<T>

Source§

fn eq(&self, other: &GenericId<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T: PartialOrd + IdCategory> PartialOrd for GenericId<T>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl<T: IdCategory> Serialize for GenericId<T>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<T: Eq + IdCategory> Eq for GenericId<T>

Source§

impl<T: IdCategory> StructuralPartialEq for GenericId<T>

Auto Trait Implementations§

§

impl<T> Freeze for GenericId<T>

§

impl<T> RefUnwindSafe for GenericId<T>
where T: RefUnwindSafe,

§

impl<T> Send for GenericId<T>
where T: Send,

§

impl<T> Sync for GenericId<T>
where T: Sync,

§

impl<T> Unpin for GenericId<T>
where T: Unpin,

§

impl<T> UnwindSafe for GenericId<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,