Struct UserId 

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

Type-safe wrapper for user identifiers.

Stored as Arc<str> so clone() is a cheap atomic refcount increment rather than a heap allocation — critical for high-concurrency hot paths.

Implementations

impl UserId

pub const MAX_LENGTH: usize = 128

Maximum user ID length accepted from external input.

pub fn new(id: impl Into<String>) -> UserId

Creates a new UserId from a string.

Panics

Panics if the ID contains path traversal characters. Use try_new() for fallible creation.

pub fn anonymous() -> UserId

New anonymous UserId — cached singleton, clone is a free atomic increment.

pub fn try_new(id: impl Into<String>) -> Result<UserId, UserIdValidationError>

Creates a new UserId from a string, returning an error if validation fails.

Security

Validates that the ID does not contain path traversal characters and only uses the canonical safe alphabet:

• .. (parent directory)
• / or \ (directory separators)
• Null bytes (\0)
• ASCII letters, digits, _, and -

This prevents path traversal attacks when user IDs are used in storage paths.

pub fn as_str(&self) -> &str

Returns the user ID as a string slice.

pub fn into_string(self) -> String

Consumes the wrapper and returns the inner String.

pub fn root() -> UserId

Creates a default ‘root’ user ID — cached singleton.

pub fn system() -> UserId

Creates a default ‘system’ user ID — cached singleton.

pub fn is_admin(&self) -> bool

Is admin user?

pub fn is_anonymous(&self) -> bool

Is anonymous user?

Trait Implementations

impl AsRef<[u8]> for UserId

fn as_ref(&self) -> &[u8]

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

impl AsRef<str> for UserId

fn as_ref(&self) -> &str

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

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<'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 Display for UserId

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

Formats the value using the given formatter.

impl Eq for UserId

impl From<&str> for UserId

fn from(s: &str) -> UserId

Converts a &str into UserId.

Panics

Panics if the string contains path traversal characters.

impl From<String> for UserId

fn from(s: String) -> UserId

Converts a String into UserId.

Panics

Panics if the string contains path traversal characters.

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 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 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 StorageKey for UserId

fn storage_key(&self) -> Vec<u8>

Serialize this key to bytes for storage using order-preserving encoding.

fn from_storage_key(bytes: &[u8]) -> Result<UserId, String>

Deserialize this key from bytes

impl StructuralPartialEq for UserId