SessionId

Struct SessionId 

Source
pub struct SessionId(/* private fields */);
Expand description

Session identifier value object for type-safe session management

This value object provides type-safe session identification with session lifecycle management, security context tracking, and comprehensive validation capabilities. It implements Domain-Driven Design (DDD) value object patterns with immutable semantics and session-specific features.

§Key Features

  • Type Safety: Strongly-typed session identifiers that cannot be confused with other IDs
  • Session Lifecycle: ULID-based time-ordered creation sequence for session tracking
  • Security Context: Natural chronological ordering for audit trails and security tracking
  • Cross-Platform: Consistent representation across languages and storage systems
  • Session Validation: Comprehensive session-specific validation with expiration management
  • Serialization: Full serialization support for storage and API integration

§Benefits Over Raw ULIDs

  • Type Safety: SessionId cannot be confused with PipelineId or other entity IDs
  • Domain Semantics: Clear intent in function signatures and session business logic
  • Session Validation: Session-specific validation rules with expiration and constraints
  • Future Evolution: Extensible for session-specific methods and features

§Session Management Benefits

  • Audit Trails: Natural time ordering for session events and security tracking
  • Uniqueness: ULID guarantees global uniqueness across distributed systems
  • Traceability: Easy tracking of session lifecycles and state changes
  • Type Safety: Cannot be confused with other ID types in complex session workflows
  • Expiration: Built-in expiration validation with configurable timeout periods

§Usage Examples

§Cross-Language Mapping

  • Rust: SessionId newtype wrapper with full validation
  • Go: SessionID struct with equivalent interface
  • JSON: String representation of ULID for API compatibility
  • Database: TEXT column with ULID string storage

Implementations§

Source§

impl SessionId

Source

pub fn new() -> Self

Creates a new session ID with current timestamp

§Purpose

Generates a unique, time-ordered session identifier using ULID. Each session ID captures the exact moment of session creation.

§Why

Time-ordered session IDs provide:

  • Natural chronological sorting for session tracking
  • Built-in creation timestamp for expiration checks
  • Guaranteed uniqueness across distributed systems
  • Audit trail support without additional timestamps
§Returns

New SessionId with current millisecond timestamp

§Examples
Source

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

Creates a session ID from an existing ULID

Source

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

Creates a session ID from a string representation

Source

pub fn from_timestamp_ms(timestamp_ms: u64) -> Self

Creates a session ID from a timestamp (for testing/migration)

Source

pub fn as_ulid(&self) -> Ulid

Gets the underlying ULID value

Source

pub fn timestamp_ms(&self) -> u64

Gets the timestamp component

Source

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

Gets the creation time as a DateTime

Source

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

Gets the ID category

Source

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

Validates the session ID using category-specific rules

Source

pub fn is_nil(&self) -> bool

Checks if this is a nil session ID

Source

pub fn is_expired(&self, timeout_minutes: u64) -> bool

Checks if the session is expired based on timeout

Source

pub fn age_minutes(&self) -> i64

Gets the session age in minutes

Trait Implementations§

Source§

impl AsRef<Ulid> for SessionId

Source§

fn as_ref(&self) -> &Ulid

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

impl Clone for SessionId

Source§

fn clone(&self) -> SessionId

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 Debug for SessionId

Source§

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

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

impl Default for SessionId

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for SessionId

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 Display for SessionId

Source§

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

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

impl From<SessionId> for Ulid

Source§

fn from(id: SessionId) -> Self

Converts to this type from the input type.
Source§

impl From<Ulid> for SessionId

Source§

fn from(ulid: Ulid) -> Self

Converts to this type from the input type.
Source§

impl FromStr for SessionId

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 Hash for SessionId

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 Ord for SessionId

Source§

fn cmp(&self, other: &SessionId) -> 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 PartialEq for SessionId

Source§

fn eq(&self, other: &SessionId) -> 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 PartialOrd for SessionId

Source§

fn partial_cmp(&self, other: &SessionId) -> 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 Serialize for SessionId

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 Eq for SessionId

Source§

impl StructuralPartialEq for SessionId

Auto Trait Implementations§

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>,