Struct ChildName

pub struct ChildName {
    pub name: LongName,
    pub collection: Option<Name>,
}

A ChildName locally identifies a child component instance using the name assigned by its parent and its collection (if present). It is the building block of [Moniker].

Display notation: “[collection:]name”.

Fields

name: LongName

collection: Option<Name>

Implementations

impl ChildName

pub fn new(name: LongName, collection: Option<Name>) -> Self

pub fn try_new<S>(name: S, collection: Option<S>) -> Result<Self, MonikerError>

where S: AsRef<str> + Into<String>,

pub fn parse<T: AsRef<str>>(rep: T) -> Result<Self, MonikerError>

Parses a ChildName from a string.

Input strings should be of the format [collection:]name, e.g. foo or biz:foo.

pub fn name(&self) -> &LongName

pub fn collection(&self) -> Option<&Name>

Trait Implementations

impl Clone for ChildName

fn clone(&self) -> ChildName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChildName

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

Formats the value using the given formatter.

impl Display for ChildName

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

Formats the value using the given formatter.

impl From<ChildName> for ChildRef

fn from(child_name: ChildName) -> Self

Converts to this type from the input type.

impl From<ChildRef> for ChildName

fn from(child_ref: ChildRef) -> Self

Converts to this type from the input type.

impl Hash for ChildName

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 ChildName

fn cmp(&self, other: &Self) -> 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 ChildName

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

fn partial_cmp(&self, other: &Self) -> 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 TryFrom<&str> for ChildName

type Error = MonikerError

The type returned in the event of a conversion error.

fn try_from(rep: &str) -> Result<Self, MonikerError>

Performs the conversion.

impl Eq for ChildName

impl StructuralPartialEq for ChildName