Struct TenantId 

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

Which tenant a run, key, or decision belongs to.

Deliberately a validated newtype rather than a bare String. A tenant name reaches storage keys and key-ring scopes, so a name containing a separator could make two different tenants produce one scope — the failure that looks like nothing at all until one of them erases the other’s data.

Deserialization is a constructor, and it takes the same door

#[serde(try_from)] rather than a derived Deserialize, because a derive would reach the private field directly and hand out exactly the names new exists to refuse. That is not a hypothetical door: a tenant arrives from a credential claim an Authenticator parsed, a store row, or a journal record, and every one of those is serde rather than a call to new. A TenantId holding acme/prod makes keyring::scope derive one key scope for two distinct tenants, so either tenant’s erasure destroys the other’s key and reports success.

A stored name that no longer parses is therefore a read error, which is the honest outcome: silently accepting it is what lets the collision exist.

Implementations

impl TenantId

pub const MAX_LEN: usize = 64

The longest a tenant name may be.

Bounded because the name reaches metric labels and storage keys. An unbounded label is an unbounded cardinality problem, which is how a metrics backend falls over for a reason nobody connects to a tenant name.

pub const DEFAULT: &'static str = "default"

The tenant a deployment that never named one is running as.

Single-tenant is the ordinary case and must not require ceremony. It is a real tenant rather than an absence, so the single- and multi-tenant paths are the same code — a special “no tenant” case is a second path, and the second path is the one that does not get tested.

pub fn new(name: impl Into<String>) -> Result<Self, TenantError>

Name a tenant.

Errors

If the name is empty, over MAX_LEN, or contains a character that composite keys use as a separator.

pub fn as_str(&self) -> &str

The name, for building a composite key.

Trait Implementations

impl Clone for TenantId

fn clone(&self) -> Self

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 Default for TenantId

fn default() -> Self

Returns the “default value” for a type.

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

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

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for TenantId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for TenantId

fn partial_cmp(&self, other: &Self) -> 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 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 StructuralPartialEq for TenantId

impl TryFrom<String> for TenantId

type Error = TenantError

The type returned in the event of a conversion error.

fn try_from(name: String) -> Result<Self, Self::Error>

Performs the conversion.