Struct UserId 

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

User (subject / principal) identifier. Adopter-supplied, same constructor surface as TenantId. Distinct Self::SYSTEM sentinel from the tenant so applications installing real rows for both don’t collapse them.

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 UserId

pub const NIL: UserId

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

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

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

Wrap an existing Uuid.

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

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]) -> UserId

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) -> UserId

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.

impl UserId

pub const SYSTEM_STR: &'static str = "00000000-0000-0000-0000-000000000001"

String form of the reserved system-user identifier ("00000000-0000-0000-0000-000000000001"). Distinct from TenantId::SYSTEM_STR so that an application installing real rows for both doesn’t collapse the system tenant and the system user onto the same identifier.

pub const SYSTEM: UserId

The reserved system-user sentinel: non-nil, distinct from TenantId::SYSTEM.

pub const fn system() -> UserId

The reserved system-user identifier.

pub fn is_system(&self) -> bool

true when this identifier names the system user.

Trait Implementations

impl Archive for UserId

where Uuid: Archive,

const COPY_OPTIMIZATION: CopyOptimization<UserId>

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

type Archived = ArchivedUserId

The archived representation of this type.

type Resolver = UserIdResolver

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: <UserId as Archive>::Resolver, out: Place<<UserId as Archive>::Archived>, )

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

impl Clone for UserId

fn clone(&self) -> UserId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserId

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

Formats the value using the given formatter.

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

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

Available on crate feature sqlx only.

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

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

impl<'de> Deserialize<'de> for UserId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

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

Deserializes using the given deserializer

impl Display for UserId

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

Formats the value using the given formatter.

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

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 UserId

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

Converts to this type from the input type.

impl From<Uuid> for UserId

fn from(uuid: Uuid) -> UserId

Converts to this type from the input type.

impl FromStr for UserId

type Err = IdError

The associated error which can be returned from parsing.

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

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

impl Hash for UserId

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 UserId

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

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

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

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

fn serialize( &self, serializer: &mut __S, ) -> Result<<UserId 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 UserId

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<DB> Type<DB> for UserId

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 UserId

impl Eq for UserId

impl StructuralPartialEq for UserId