Struct TenantId 

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

One tenant’s id, and the field type of a resource’s tenant column.

A model declares its tenant column with this type:

#[derive(Debug, Clone, toasty::Model)]
pub struct Note {
    #[key]
    #[auto]
    id: uuid::Uuid,
    #[index]
    tenant_id: TenantId,
    body: String,
}

Tenancy::column and Tenancy::via accept only a TenantColumn, so a lens naming any other Uuid column — an author, a parent row, the key — does not compile. The column stores a UUID, so the database column is unchanged.

Implementations

impl TenantId

pub fn get(self) -> Uuid

The id, as tenant_id answers it and a session carries it.

Trait Implementations

impl Assign<TenantId> for TenantId

fn into_assignment(self) -> Assignment<TenantId>

Convert into an Assignment<T> value.

fn assign(self, assignments: &mut Assignments, projection: Projection)

where Self: Sized,

Record one or more assignments into the given [Assignments] map at the specified projection.

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

impl Debug for TenantId

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

Formats the value using the given formatter.

impl Display for TenantId

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

Formats the value using the given formatter.

impl Eq for TenantId

impl Field for TenantId

type ExprTarget = TenantId

The expression-level type of this field.

type Path<Origin> = Path<Origin, TenantId>

The type returned when accessing this field from a Fields struct. For primitives, this is Path<Origin, Self>. For embedded types, this is {Type}Fields.

type ListPath<Origin> = Path<Origin, List<<TenantId as Field>::ExprTarget>>

The type returned when accessing this field from a list Fields struct. For primitives, this is Path<Origin, ListSelf::ExprTarget>. For embedded types, this is {Type}ListFields.

type Update<'a> = ()

The type of the update builder for this field. For embedded types, this is {Type}Update<’a>. For primitives, this will be {Type}Update<’a> once implemented.

type Inner = TenantId

The unwrapped type used for foreign key filter expressions. Primitives map to themselves. Wrappers like Option<T>, Box<T>, Arc<T>, and Rc<T> map to T::Inner.

fn new_path<Origin>(path: Path<Origin, Self>) -> Self::Path<Origin>

Build a field path from a raw path of the field’s Self::ExprTarget.

fn new_list_path<Origin>( path: Path<Origin, List<Self::ExprTarget>>, ) -> Self::ListPath<Origin>

Build a list field path from a raw path. For primitives, returns the path as-is. For embedded types, wraps the path in a ListFields struct.

fn new_update<'a>( _assignments: &'a mut Assignments, _projection: Projection, ) -> Self::Update<'a>

Build an update builder from assignments and a projection. For primitives, this returns () (no builder). For embedded types, this is overridden to construct the {Type}Update builder.

fn key_constraint<Origin>( &self, target: Path<Origin, Self::Inner>, ) -> Expr<bool>

Build a boolean filter expression comparing this field value against a target path. Used by generated belongs-to accessors to build FK lookups.

const NULLABLE: bool = false

Whether or not the type is nullable

const DEFERRED: bool = false

Whether this field is omitted from default loads.

fn field_ty(storage_ty: Option<Type>) -> FieldTy

Returns the app-level field type for this primitive. Default implementation returns a Primitive field type. Embedded types override this to return Embedded field type.

fn register(_model_set: &mut ModelSet)

Register any models referenced by this field type into the given ModelSet.

impl From<Uuid> for TenantId

fn from(id: Uuid) -> Self

Converts to this type from the input type.

impl FromStr for TenantId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this 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 IndexableField for TenantId

impl IntoExpr<TenantId> for TenantId

fn into_expr(self) -> Expr<TenantId>

Consume self and produce an Expr<T>.

fn by_ref(&self) -> Expr<TenantId>

Produce an Expr<T> from a reference without consuming self.

impl Load for TenantId

type Output = TenantId

The concrete type produced by load.

fn ty() -> Type

Returns the stmt::Type that describes values of this type.

fn load(value: Value) -> Result<Self::Output, Error>

Deserialize a database Value into Self::Output.

fn reload(target: &mut Self::Output, value: Value) -> Result<(), Error>

Reload the value in-place from a value returned by the database.

fn ty_relation() -> Type

Returns the stmt::Type used when this type appears as a relation target. The default delegates to ty().

fn load_relation(value: Value) -> Result<Self::Output, Error>

Deserialize a value that was loaded as a relation target.

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

impl TenantColumn for TenantId

fn from_tenant(id: Uuid) -> Self

The column’s value for the request tenant id.

impl TypedValue for TenantId

const NOUN: &'static str = "identifier"

What this type is called in a validation error.

const INPUT_TYPE: &'static str = "text"

The type attribute of the text control that edits it.

fn parse_input(value: &str) -> Option<Self>

Reads a trimmed, non-empty submission, or None when the type refuses it.