Struct ComponentContext 

pub struct ComponentContext { /* private fields */ }

A component context.

Holds the identifiers (absolute and relative) for a component, as well as its type.

Implementations

impl ComponentContext

pub fn new( topology_root: &SubsystemIdentifier, component_id: ComponentId, component_type: ComponentType, ) -> Self

Creates a new ComponentContext rooted at the given topology, with the given identifier and type.

pub fn source( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for a source component with the given identifier, within the named topology.

pub fn relay( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for a relay component with the given identifier, within the named topology.

pub fn decoder( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for a decoder component with the given identifier, within the named topology.

pub fn transform( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for a transform component with the given identifier, within the named topology.

pub fn encoder( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for an encoder component with the given identifier, within the named topology.

pub fn forwarder( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for a forwarder component with the given identifier, within the named topology.

pub fn destination( topology_root: &SubsystemIdentifier, component_id: ComponentId, ) -> Self

Creates a new ComponentContext for a destination component with the given identifier, within the named topology.

pub fn component_id(&self) -> &ComponentId

Returns the component identifier.

This is the relative identifier of the component, unique within its topology but not guaranteed to be globally unique. See ComponentContext::identity for the fully qualified identity.

pub fn component_type(&self) -> ComponentType

Returns the component type.

pub fn identity(&self) -> SubsystemIdentifier

Returns the fully qualified identity of this component.

The returned identifier uniquely identifies the component within the process, inclusive of the topology to which it belongs.

Trait Implementations

impl Clone for ComponentContext

fn clone(&self) -> ComponentContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentContext

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

Formats the value using the given formatter.

impl Display for ComponentContext

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

Formats the value using the given formatter.

impl Hash for ComponentContext

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 PartialEq for ComponentContext

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

impl StructuralPartialEq for ComponentContext