Struct ComponentInstanceId 

pub struct ComponentInstanceId(/* private fields */);

The identity of one component instance in the compiled robot.

Implementations

impl ComponentInstanceId

pub const KIND: &'static str = "component instance id"

What this identifier names, used in diagnostics.

pub fn new( value: impl Into<String>, ) -> Result<ComponentInstanceId, TopologyIdError>

Validate and construct the identifier.

pub fn as_str(&self) -> &str

The canonical wire token.

Trait Implementations

impl AsRef<str> for ComponentInstanceId

fn as_ref(&self) -> &str

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

impl Borrow<str> for ComponentInstanceId

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ComponentInstanceId

fn clone(&self) -> ComponentInstanceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentInstanceId

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

Formats the value using the given formatter.

impl DescribeWire for ComponentInstanceId

fn wire_schema() -> WireSchema

The shape a value of this type puts on the wire.

impl<'de> Deserialize<'de> for ComponentInstanceId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ComponentInstanceId

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

Formats the value using the given formatter.

impl Eq for ComponentInstanceId

impl FromStr for ComponentInstanceId

type Err = TopologyIdError

The associated error which can be returned from parsing.

fn from_str( value: &str, ) -> Result<ComponentInstanceId, <ComponentInstanceId as FromStr>::Err>

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

impl Hash for ComponentInstanceId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 ComponentInstanceId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for ComponentInstanceId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for ComponentInstanceId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ComponentInstanceId

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ComponentInstanceId

impl TryFrom<String> for ComponentInstanceId

type Error = TopologyIdError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ComponentInstanceId, <ComponentInstanceId as TryFrom<String>>::Error>

Performs the conversion.