Struct TenantSet 

pub struct TenantSet { /* private fields */ }

An immutable, validated snapshot of every tenant and outstanding code.

Implementations

impl TenantSet

pub fn new(tenants: Vec<Tenant>, codes: Vec<EnrollCode>) -> Result<Self>

Builds a snapshot, rejecting anything that would make identification or routing ambiguous: duplicate names, duplicate hosts, a PSK shared by two entries, an empty host, or a zero connection limit.

pub fn tenants(&self) -> &[Tenant]

pub fn codes(&self) -> &[EnrollCode]

pub fn tenant(&self, name: &str) -> Option<&Tenant>

pub fn tenant_by_sni(&self, sni: &str) -> Option<&Tenant>

The enabled tenant routed by sni, if any.

pub fn candidates(&self, now_unix: u64) -> Candidates

PSKs worth trying at now_unix seconds: enabled tenants and codes that have not expired.

impl TenantSet

Edits. Each returns a new validated set and leaves self untouched.

pub fn with_tenant(&self, tenant: Tenant) -> Result<Self>

pub fn with_code(&self, code: EnrollCode) -> Result<Self>

pub fn without_tenant(&self, name: &str) -> Result<Self>

pub fn with_disabled(&self, name: &str, disabled: bool) -> Result<Self>

pub fn redeem( &self, code_psk: &Psk, now_unix: u64, name: String, psk: Psk, ) -> Result<(Self, Tenant)>

Burns the code whose PSK is code_psk and creates a tenant from it under name with PSK psk. Fails, changing nothing, if there is no such code or it has expired at now_unix.

impl TenantSet

pub fn from_toml(text: &str) -> Result<Self>

pub fn to_toml(&self) -> Result<String>

pub fn load(path: &Path) -> Result<Self>

Reads a tenant file. A missing file is an empty set, so a fresh deployment can start serve before issuing anything.

Trait Implementations

impl Clone for TenantSet

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 TenantSet

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

Formats the value using the given formatter.

impl Default for TenantSet

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TenantSet

impl PartialEq for TenantSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TenantSet