Struct TenantId 

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

Type-safe tenant identifier wrapper to prevent cross-tenant data leakage

This newtype provides compile-time guarantees that:

1. Tenant IDs cannot be accidentally mixed with other string types
2. All tenant-scoped operations explicitly require a TenantId
3. Cross-tenant operations are caught at compile time

Security

By making TenantId a distinct type, we enforce that all storage operations, queries, and business logic explicitly handle tenant isolation. This prevents entire classes of security vulnerabilities where tenant_id strings might be accidentally omitted, swapped, or compared incorrectly.

Examples

use uvb_core::TenantId;

// Create a tenant ID
let tenant_id = TenantId::new("tenant_123");

// Access the inner value when needed
assert_eq!(tenant_id.as_str(), "tenant_123");

// Clone is cheap (wraps a String)
let cloned = tenant_id.clone();
assert_eq!(tenant_id, cloned);

Implementations

impl TenantId

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

Create a new TenantId from a string

Arguments

• id - The tenant identifier string

Examples

use uvb_core::TenantId;

let tenant_id = TenantId::new("tenant_123");

pub fn as_str(&self) -> &str

Get the tenant ID as a string slice

Examples

use uvb_core::TenantId;

let tenant_id = TenantId::new("tenant_123");
assert_eq!(tenant_id.as_str(), "tenant_123");

pub fn into_inner(self) -> String

Consume the TenantId and return the inner String

Examples

use uvb_core::TenantId;

let tenant_id = TenantId::new("tenant_123");
let inner: String = tenant_id.into_inner();
assert_eq!(inner, "tenant_123");

pub fn is_valid(&self) -> bool

Validate that the tenant ID is well-formed

Returns true if the tenant ID:

• Is not empty
• Contains only alphanumeric characters, hyphens, and underscores
• Is between 1 and 255 characters long

Examples

use uvb_core::TenantId;

assert!(TenantId::new("tenant_123").is_valid());
assert!(TenantId::new("tenant-abc-123").is_valid());
assert!(!TenantId::new("").is_valid());
assert!(!TenantId::new("tenant with spaces").is_valid());

Trait Implementations

impl AsRef<str> for TenantId

fn as_ref(&self) -> &str

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

impl Clone for TenantId

fn clone(&self) -> TenantId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TenantId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TenantId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TenantId

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

Formats the value using the given formatter.

impl From<&str> for TenantId

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for TenantId

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<TenantId> for String

fn from(tenant_id: TenantId) -> Self

Converts to this type from the input type.

impl Hash for TenantId

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

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<&str> for TenantId

fn eq(&self, other: &&str) -> 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 PartialEq<String> for TenantId

fn eq(&self, other: &String) -> 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 PartialEq<TenantId> for &str

fn eq(&self, other: &TenantId) -> 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 PartialEq<TenantId> for String

fn eq(&self, other: &TenantId) -> 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 PartialEq<str> for TenantId

fn eq(&self, other: &str) -> 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 PartialEq for TenantId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TenantId

impl StructuralPartialEq for TenantId