Struct stylecs::Name

pub struct Name {
    pub authority: Identifier,
    pub name: Identifier,
}

A globally unique name.

This structure has an authority and a name.

Fields

authority: Identifier

The unique name of the source of this name. For example, this could be the name of the crate it was defined within.

Identifier::private() is used as the authority when Name::private() is called.

name: Identifier

The locally unique name.

This name only needs to be unique within its authority. For example, two authorities can define their own color components without conflicts.

Implementations

impl Name

pub fn private(name: impl Identifiable) -> Result<Self, InvalidIdentifier>

Returns a new Name with _ used as the authority.

This is equivalent to calling Name::new("_", name).

Errors

Returns InvalidIdentifier if any invalid Identifier characters are encountered.

pub fn new( authority: impl Identifiable, name: impl Identifiable ) -> Result<Self, InvalidIdentifier>

Returns a new Name using authority and name.

Each name should be unique within the authority namespace.

Errors

Returns InvalidIdentifier if any invalid Identifier characters are encountered.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl<'a> From<&'a Name> for Cow<'a, Name>

fn from(value: &'a Name) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Name> for NameKey<'a>

fn from(value: &'a Name) -> Self

Converts to this type from the input type.

impl<'a> From<&'a StaticName> for Name

fn from(value: &'a StaticName) -> Self

Converts to this type from the input type.

impl<'a> From<Name> for Cow<'a, Name>

fn from(value: Name) -> Self

Converts to this type from the input type.

impl From<Name> for NameKey<'_>

fn from(value: Name) -> Self

Converts to this type from the input type.

impl<'a> From<NameKey<'a>> for Name

fn from(name: NameKey<'a>) -> Self

Converts to this type from the input type.

impl FromStr for Name

type Err = InvalidIdentifier

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 Hash for Name

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 Name

fn cmp(&self, other: &Name) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Name> for Name

fn eq(&self, other: &Name) -> 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 PartialOrd<Name> for Name

fn partial_cmp(&self, other: &Name) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Name

impl StructuralEq for Name

impl StructuralPartialEq for Name