Struct vector::config::ComponentKey

pub struct ComponentKey { /* private fields */ }

Component identifier.

Implementations

impl ComponentKey

pub fn id(&self) -> &str

pub fn join<D>(&self, name: D) -> ComponentKey

where D: Display,

pub fn port<D>(&self, name: D) -> String

where D: Display,

pub fn into_id(self) -> String

Trait Implementations

impl Clone for ComponentKey

fn clone(&self) -> ComponentKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for ComponentKey

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for ComponentKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComponentKey

fn deserialize<__D>( __deserializer: __D, ) -> Result<ComponentKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ComponentKey

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

Formats the value using the given formatter.

impl From<&ComponentKey> for OutputId

fn from(key: &ComponentKey) -> OutputId

Converts to this type from the input type.

impl From<&str> for ComponentKey

fn from(value: &str) -> ComponentKey

Converts to this type from the input type.

impl From<ComponentKey> for OutputId

fn from(key: ComponentKey) -> OutputId

Converts to this type from the input type.

impl From<ComponentKey> for String

fn from(key: ComponentKey) -> String

Converts to this type from the input type.

impl From<String> for ComponentKey

fn from(id: String) -> ComponentKey

Converts to this type from the input type.

impl Hash for ComponentKey

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 ComponentKey

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

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

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

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 ToValue for ComponentKey

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl ConfigurableString for ComponentKey

impl Eq for ComponentKey

impl StructuralPartialEq for ComponentKey