Struct architect_api::utils::component_id::ComponentId

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

Components within an Architect installation are uniquely identified by a 16-bit integer in the range 1..<0xFFFF.

The integers 0 and 0xFFFF are reserved as special values and MUST NOT be used as component IDs.

Canonical meanings of special values:

• 0x0 – None/executor/broadcast
• 0xFFFF – Self/loopback

Implementations

impl ComponentId

pub fn new(id: u16) -> Result<Self, ComponentIdError>

pub fn none() -> Self

pub fn is_none(&self) -> bool

pub fn loopback() -> Self

pub fn is_loopback(&self) -> bool

pub fn filename(&self) -> String

Trait Implementations

impl Clone for ComponentId

fn clone(&self) -> ComponentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComponentId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ComponentId

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

Formats the value using the given formatter.

impl FromStr for ComponentId

type Err = ComponentIdError

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 FromValue for ComponentId

fn from_value(v: Value) -> Result<Self>

attempt to cast v to the type of self using any reasonable means

fn get(v: Value) -> Option<Self>

where Self: Sized,

extract the type of self from v if the type of v is equivelent to the type of self, otherwise return None.

impl Hash for ComponentId

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 Into<Value> for ComponentId

fn into(self) -> Value

Converts this type into the (usually inferred) input type.

impl Ord for ComponentId

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

fn encoded_len(&self) -> usize

fn encode(&self, buf: &mut impl BufMut) -> Result<(), PackError>

fn decode(buf: &mut impl Buf) -> Result<Self, PackError>

fn const_encoded_len() -> Option<usize>

fn decode_into(&mut self, buf: &mut impl Buf) -> Result<(), PackError>

where Self: Sized,

impl PartialEq for ComponentId

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ComponentId

impl Eq for ComponentId

impl StructuralEq for ComponentId

impl StructuralPartialEq for ComponentId