Struct spacetimedb_lib::name::DomainName

pub struct DomainName { /* private fields */ }

A DomainName is the name of a database.

A database name is usually in one of the two following forms:

my_database_name

or

my_domain/mypath

You can also have as many path segments as you want (as long as it’s less than 256):

my_domain/a/b/c/d

Database names must NOT end or start in a slash and cannot have 2 slashes in a row. These are all invalid:

my_domain/a//c/d /my_domain my_domain/

Each segment in a database name can contain any UTF-8 character, except for whitespace and ‘/’. The maximum segment length is 64 characters.

The first path segment is also referred to as the “top-level domain”, or Tld. The concatenation of all segments after the first ‘/’ is also referred as the “subdomain”.

Note that PartialEq compares the exact string representation of a DomainName, as one would expect, but the SpacetimeDB registry compares the lowercase representation of it.

To construct a valid DomainName, use parse_domain_name or the FromStr impl.

Implementations

impl DomainName

pub fn as_str(&self) -> &str

Returns a string slice with the domain name.

pub fn tld(&self) -> &TldRef

Get the top-level domain, as a reference.

pub fn to_tld(&self) -> Tld

Get the top-level domain, as an owned Tld.

pub fn sub_domain(&self) -> Option<&str>

Get the subdomain, if any.

pub fn to_lowercase(&self) -> String

Render the name as a lower-case, ‘/’-separated string, suitable for use as a unique constrained field in a database.

Trait Implementations

impl AsRef<str> for DomainName

fn as_ref(&self) -> &str

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

impl Clone for DomainName

fn clone(&self) -> DomainName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DomainName

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for DomainName

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given deserializer.

impl Display for DomainName

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

Formats the value using the given formatter.

impl From<DomainName> for Tld

fn from(value: DomainName) -> Self

Converts to this type from the input type.

impl From<Tld> for DomainName

fn from(tld: Tld) -> Self

Converts to this type from the input type.

impl FromStr for DomainName

type Err = DomainParsingError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for DomainName

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DomainName

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for DomainName

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize self in the data format of S using the provided serializer.

impl SpacetimeType for DomainName

fn make_type<S: TypespaceBuilder>(_ts: &mut S) -> AlgebraicType

Returns an AlgebraicType representing the type for Self in SATS and in the typing context in typespace.

impl Eq for DomainName

impl StructuralEq for DomainName

impl StructuralPartialEq for DomainName