Enum Name

pub enum Name {
    Suffixed(String, ShortUuid),
    Reserved(String),
}

Names are used to identify objects in the system. They have a user-provided name, and a unique UUID.

Names have a concrete syntax–{name}-{uuid}–printed by Display and parsed by FromStr.

Variants

Suffixed(String, ShortUuid)

Normal names for most actors.

Reserved(String)

Reserved names for system actors without UUIDs.

Implementations

impl Name

pub fn is_suffixed(&self) -> bool

Returns true if this is a Name::Suffixed, otherwise false

pub fn as_suffixed_mut(&mut self) -> Option<(&mut String, &mut ShortUuid)>

Optionally returns mutable references to the inner fields if this is a Name::Suffixed, otherwise None

pub fn as_suffixed(&self) -> Option<(&String, &ShortUuid)>

Optionally returns references to the inner fields if this is a Name::Suffixed, otherwise None

pub fn into_suffixed(self) -> Result<(String, ShortUuid), Self>

Returns the inner fields if this is a Name::Suffixed, otherwise returns back the enum in the Err case of the result

pub fn is_reserved(&self) -> bool

Returns true if this is a Name::Reserved, otherwise false

pub fn as_reserved_mut(&mut self) -> Option<&mut String>

Optionally returns mutable references to the inner fields if this is a Name::Reserved, otherwise None

pub fn as_reserved(&self) -> Option<&String>

Optionally returns references to the inner fields if this is a Name::Reserved, otherwise None

pub fn into_reserved(self) -> Result<String, Self>

Returns the inner fields if this is a Name::Reserved, otherwise returns back the enum in the Err case of the result

impl Name

pub fn new(name: impl Into<String>) -> Self

Create a new Name from a user-provided base name.

pub fn name(&self) -> &str

The name portion of this Name.

pub fn uuid(&self) -> Option<&ShortUuid>

The UUID portion of this Name. Only Some for Name::Suffixed, if called on Name::Reserved it’ll be None.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate 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<'de> Deserialize<'de> for Name

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl FromStr for Name

type Err = NameParseError

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) -> 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.

impl PartialEq for Name

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd 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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Name

impl StructuralPartialEq for Name