Struct cm_moniker::InstancedMoniker

pub struct InstancedMoniker { /* private fields */ }

An instanced moniker describes the identity of a component instance in terms of its path relative to the root of the component instance tree.

A root moniker is a moniker with an empty path.

Instanced monikers are only used internally within the component manager. Externally, components are referenced by encoded moniker so as to minimize the amount of information which is disclosed about the overall structure of the component instance tree.

Display notation: “.”, “name1:1”, “name1:1/name2:2”, …

Implementations

impl InstancedMoniker

pub fn from_moniker_with_zero_value_instance_ids( moniker: &Moniker ) -> InstancedMoniker

Create a new InstancedMoniker with zero-value InstanceIds for all path parts in moniker.

pub fn without_instance_ids(&self) -> Moniker

Convert an InstancedMoniker into an allocated Moniker without InstanceIds

pub fn with_zero_value_instance_ids(&self) -> InstancedMoniker

Transforms an InstancedMoniker into a representation where all dynamic children have 0 value instance ids.

Trait Implementations

impl Clone for InstancedMoniker

fn clone(&self) -> InstancedMoniker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstancedMoniker

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

Formats the value using the given formatter.

impl Default for InstancedMoniker

fn default() -> InstancedMoniker

Returns the “default value” for a type.

impl Display for InstancedMoniker

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

Formats the value using the given formatter.

impl From<InstancedMoniker> for InstancedExtendedMoniker

fn from(m: InstancedMoniker) -> Self

Converts to this type from the input type.

impl Hash for InstancedMoniker

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 MonikerBase for InstancedMoniker

type Part = InstancedChildName

fn new(path: Vec<Self::Part>) -> Self

fn path(&self) -> &Vec<Self::Part>

fn path_mut(&mut self) -> &mut Vec<Self::Part>

fn parse<T>(path: &[T]) -> Result<Self, MonikerError>

where T: AsRef<str>,

fn parse_str(input: &str) -> Result<Self, MonikerError>

fn concat<T>(&self, other: &T) -> Self

where T: MonikerBase<Part = Self::Part>,

Concatenates other onto the end of this moniker.

fn has_prefix<S>(&self, prefix: &S) -> bool

where S: MonikerBase<Part = Self::Part>,

Indicates whether this moniker is prefixed by prefix.

fn root() -> Self

fn leaf(&self) -> Option<&Self::Part>

fn is_root(&self) -> bool

fn parent(&self) -> Option<Self>

fn child(&self, child: Self::Part) -> Self

fn strip_prefix<T>(&self, prefix: &T) -> Result<Self, MonikerError>

where T: MonikerBase<Part = Self::Part>,

Strips the moniker parts in prefix from the beginning of this moniker.

fn compare(&self, other: &Self) -> Ordering

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

impl Ord for InstancedMoniker

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for InstancedMoniker

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

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

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 TryFrom<&str> for InstancedMoniker

type Error = MonikerError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<&str>> for InstancedMoniker

type Error = MonikerError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for InstancedMoniker

impl StructuralPartialEq for InstancedMoniker