Struct ReservedDomains 

pub struct ReservedDomains { /* private fields */ }

Names that are never a tenant’s to claim.

The platform’s own hostnames belong here – the API’s, the dashboard’s, the one the proxy’s TLS listener answers for itself. Registration of these is refused before verification is even attempted: an unverified row for the platform’s name is harmless only for as long as every later check remembers to look at verification_status, and that is one forgotten check away from a tenant’s certificate being served for it.

Default reserves the special-use names that never denote a public host (RFC 6761, 6762, 7686, 8375, 9476): localhost, local, internal, arpa, invalid, onion, alt, and localdomain. Add the platform’s own with with_exact and with_suffix.

Implementations

impl ReservedDomains

pub fn none() -> Self

Nothing reserved at all, not even the special-use names.

For tests and for embedders that do their own checking. The special-use names cannot be verified anyway, so leaving them out costs little, but there is no reason to.

pub fn with_exact(self, name: &str) -> Self

Reserve exactly this name, and not its subdomains.

Panics if name is not a valid domain: a reservation that silently matches nothing is worse than a startup failure.

pub fn with_suffix(self, suffix: &str) -> Self

Reserve this name and every name under it.

with_suffix("example.com") reserves example.com and api.example.com, not notexample.com. Panics on an invalid name, as with_exact does.

pub fn is_reserved(&self, normalized: &str) -> bool

Whether a name, already in normalize_domain form, is reserved.

Trait Implementations

impl Clone for ReservedDomains

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 ReservedDomains

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

Formats the value using the given formatter.

impl Default for ReservedDomains

fn default() -> Self

Returns the “default value” for a type.