Struct SessionId 

pub struct SessionId(/* private fields */);

Session identifier. axess-minted; cryptographic opacity is the security contract. A session-id leak that revealed login time would be a vulnerability for forensic correlation against externally-observed events, so prefer Self::new (UUID v4 random) over time-prefixed variants.

Logging discipline

SessionId derives std::fmt::Debug and std::fmt::Display via define_id!; both formats produce the full hyphenated UUID string. Treat session ids as credentials in logs: a SessionId that lands in a structured-log line, an observability pipeline, or a crash dump leaks a still-valid authenticator. Redact at the emission boundary (a project-local RedactedSessionId(SessionId) newtype, or manual masking of middle bytes). axess-identity does not redact at the type level because the full id form is needed at the storage and authn-validation boundaries.

Backed by uuid::Uuid (16 bytes, Copy). UUID v4 random when minted via Self::new; v5 namespaced when adopted from a non-UUID source via Self::from_namespaced_str; bytes stored verbatim when restored from persistence via Self::from_bytes. Wire format under serde is the hyphenated UUID string; under rkyv it’s the 16-byte archive layout.

Implementations

impl SessionId

pub const NIL: SessionId

All-zero sentinel. Equal to Uuid::nil.

pub fn new<R>(rng: &R) -> SessionId

where R: SecureRng,

Mint a fresh UUID v4 from the supplied SecureRng. Sets version 4 + RFC 4122 variant bits per spec; the remaining 122 bits come from rng.

pub fn try_new(value: impl AsRef<str>) -> Result<SessionId, IdError>

Construct from a string (which must be a valid hyphenated Uuid). Returns IdError::Empty for empty input or IdError::NotAUuid if parsing fails.

pub const fn from_uuid(uuid: Uuid) -> SessionId

Wrap an existing Uuid.

pub const fn from_bytes(bytes: [u8; 16]) -> SessionId

Construct from raw bytes verbatim (version and variant bits are not adjusted). For round-tripping persisted ids whose bytes already encode a valid Uuid.

pub fn from_random_bytes(bytes: [u8; 16]) -> SessionId

Construct a UUID v4-shaped id from 16 random bytes (sets version + variant bits per RFC 4122).

Prefer Self::new. This constructor is for the niche case where 16 random bytes have already been drawn (e.g. from a fixed test seed buffer or an external CSPRNG that doesn’t expose SecureRng). When you have a SecureRng in scope (production code always does, tests should), Self::new(&mut rng) is the DST-correct path: the only random source is the injected RNG, so tests that mint identity remain reproducible across runs.

pub fn from_namespaced_str(namespace: Uuid, name: &str) -> SessionId

Map a non-UUID adopter identifier (slug, OAuth subject, integer-stringified, …) to a stable id via UUID v5. Same (namespace, name) always produces the same id, so services agree without coordination.

pub const fn as_bytes(&self) -> &[u8; 16]

Borrow the raw 16-byte body. Zero-cost handoff to byte-shaped APIs.

pub const fn as_uuid(&self) -> Uuid

Get the underlying Uuid. Zero-cost conversion to any sibling newtype (other_crate::FooId::from_uuid(id.as_uuid())).

pub fn is_nil(&self) -> bool

true when this is the all-zero (Uuid::nil) sentinel.

Trait Implementations

impl Archive for SessionId

where Uuid: Archive,

const COPY_OPTIMIZATION: CopyOptimization<SessionId>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedSessionId

The archived representation of this type.

type Resolver = SessionIdResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <SessionId as Archive>::Resolver, out: Place<<SessionId as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for SessionId

fn clone(&self) -> SessionId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionId

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

Formats the value using the given formatter.

impl<'r, DB> Decode<'r, DB> for SessionId

where DB: Database, String: Decode<'r, DB>,

Available on crate feature sqlx only.

fn decode( value: <DB as Database>::ValueRef<'r>, ) -> Result<SessionId, Box<dyn Error + Send + Sync>>

Decode a new value of this type using a raw value from the database.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SessionId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D> Deserialize<SessionId, __D> for <SessionId as Archive>::Archived

where __D: Fallible + ?Sized, Uuid: Archive, <Uuid as Archive>::Archived: Deserialize<Uuid, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<SessionId, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for SessionId

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

Formats the value using the given formatter.

impl<'q, DB> Encode<'q, DB> for SessionId

where DB: Database, String: Encode<'q, DB>,

Available on crate feature sqlx only.

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

Writes the value of self into buf without moving self.

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl From<[u8; 16]> for SessionId

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

Converts to this type from the input type.

impl From<Uuid> for SessionId

fn from(uuid: Uuid) -> SessionId

Converts to this type from the input type.

impl FromStr for SessionId

type Err = IdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SessionId, <SessionId as FromStr>::Err>

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

impl Hash for SessionId

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

where __H: Hasher,

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

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

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

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

where __S: Fallible + ?Sized, Uuid: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<SessionId as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for SessionId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Store<SessionId, SessionData> for MysqlSessionStore

Available on crate feature mysql only.

type Error = SqlStoreError

Backend-specific error. Use the shared StoreError enum for new backends; legacy wrappers may continue to surface SqlStoreError / ValkeyStoreError / PostgresStoreError until each is consolidated.

fn get( &self, key: &SessionId, ) -> impl Future<Output = Result<Option<SessionData>, Self::Error>> + Send

Fetch the value for key. Ok(None) when the key is absent (including TTL-expired); Err only on backend failure.

fn put( &self, key: &SessionId, value: &SessionData, ttl: Duration, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Insert or replace the value at key with the given TTL.

fn delete( &self, key: &SessionId, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Remove the entry at key. Idempotent; does not error if absent.

fn prune_expired(&self) -> impl Future<Output = Result<u64, Self::Error>> + Send

Bulk-evict every TTL-expired entry. Returns the number reclaimed. Backends with native TTL eviction (Valkey/Redis) may implement this as a no-op returning Ok(0); backends owning their own row table (SQLite, Postgres, in-memory) actually delete.

impl Store<SessionId, SessionData> for PostgresSessionStore

Available on crate feature postgres only.

type Error = SqlStoreError

Backend-specific error. Use the shared StoreError enum for new backends; legacy wrappers may continue to surface SqlStoreError / ValkeyStoreError / PostgresStoreError until each is consolidated.

fn get( &self, key: &SessionId, ) -> impl Future<Output = Result<Option<SessionData>, Self::Error>> + Send

Fetch the value for key. Ok(None) when the key is absent (including TTL-expired); Err only on backend failure.

fn put( &self, key: &SessionId, value: &SessionData, ttl: Duration, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Insert or replace the value at key with the given TTL.

fn delete( &self, key: &SessionId, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Remove the entry at key. Idempotent; does not error if absent.

fn prune_expired(&self) -> impl Future<Output = Result<u64, Self::Error>> + Send

Bulk-evict every TTL-expired entry. Returns the number reclaimed. Backends with native TTL eviction (Valkey/Redis) may implement this as a no-op returning Ok(0); backends owning their own row table (SQLite, Postgres, in-memory) actually delete.

impl Store<SessionId, SessionData> for SqliteSessionStore

Available on crate feature sqlite only.

type Error = SqlStoreError

Backend-specific error. Use the shared StoreError enum for new backends; legacy wrappers may continue to surface SqlStoreError / ValkeyStoreError / PostgresStoreError until each is consolidated.

fn get( &self, key: &SessionId, ) -> impl Future<Output = Result<Option<SessionData>, Self::Error>> + Send

Fetch the value for key. Ok(None) when the key is absent (including TTL-expired); Err only on backend failure.

fn put( &self, key: &SessionId, value: &SessionData, ttl: Duration, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Insert or replace the value at key with the given TTL.

fn delete( &self, key: &SessionId, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Remove the entry at key. Idempotent; does not error if absent.

fn prune_expired(&self) -> impl Future<Output = Result<u64, Self::Error>> + Send

Bulk-evict every TTL-expired entry. Returns the number reclaimed. Backends with native TTL eviction (Valkey/Redis) may implement this as a no-op returning Ok(0); backends owning their own row table (SQLite, Postgres, in-memory) actually delete.

impl Store<SessionId, SessionData> for ValkeySessionStore

Available on crate feature valkey only.

type Error = ValkeyStoreError

Backend-specific error. Use the shared StoreError enum for new backends; legacy wrappers may continue to surface SqlStoreError / ValkeyStoreError / PostgresStoreError until each is consolidated.

fn get( &self, key: &SessionId, ) -> impl Future<Output = Result<Option<SessionData>, Self::Error>> + Send

Fetch the value for key. Ok(None) when the key is absent (including TTL-expired); Err only on backend failure.

fn put( &self, key: &SessionId, value: &SessionData, ttl: Duration, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Insert or replace the value at key with the given TTL.

fn delete( &self, key: &SessionId, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Remove the entry at key. Idempotent; does not error if absent.

fn prune_expired(&self) -> impl Future<Output = Result<u64, Self::Error>> + Send

Bulk-evict every TTL-expired entry. Returns the number reclaimed. Backends with native TTL eviction (Valkey/Redis) may implement this as a no-op returning Ok(0); backends owning their own row table (SQLite, Postgres, in-memory) actually delete.

impl<DB> Type<DB> for SessionId

where DB: Database, String: Type<DB>,

Available on crate feature sqlx only.

fn type_info() -> <DB as Database>::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Copy for SessionId

impl Eq for SessionId

impl StructuralPartialEq for SessionId