Struct ComponentOutputId 

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

A component output identifier.

Implementations

impl ComponentOutputId

pub fn from_definition( component_id: ComponentId, output_def: &OutputDefinition, ) -> Result<Self, (String, String)>

Creates a new ComponentOutputId from an identifier and output definition.

Errors

If generated component output ID is not valid, such as due the identifier or output definition containing invalid characters, an error is returned.

pub fn component_id(&self) -> ComponentId

Returns the component ID.

pub fn output(&self) -> OutputName

Returns the output name.

pub fn is_default(&self) -> bool

Returns true if this is a default output.

Trait Implementations

impl Clone for ComponentOutputId

fn clone(&self) -> ComponentOutputId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentOutputId

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

Formats the value using the given formatter.

impl Display for ComponentOutputId

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

Formats the value using the given formatter.

impl Hash for ComponentOutputId

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 ComponentOutputId

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

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

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

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ComponentOutputId

impl StructuralPartialEq for ComponentOutputId