Enum PortIndex

pub enum PortIndex<Kind: PortKind> {
    Port(u32),
    Param(Kind::ParamId),
    Listener(Kind::Listener),
}

A zero-indexed “port” for a node. Most nodes have one input and one output port, but some may have more. For example, a channel splitter node will have one output port for each channel.

These are essentially indices into the Chunks

Kind is a zero sized type and is useful for distinguishing between input and output ports (which may otherwise share indices)

Variants

Port(u32)

Param(Kind::ParamId)

Listener(Kind::Listener)

special variant only used for the implicit connection from listeners to params

Trait Implementations

impl<Kind: Clone + PortKind> Clone for PortIndex<Kind>

where Kind::ParamId: Clone, Kind::Listener: Clone,

fn clone(&self) -> PortIndex<Kind>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Kind: Debug + PortKind> Debug for PortIndex<Kind>

where Kind::ParamId: Debug, Kind::Listener: Debug,

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

Formats the value using the given formatter.

impl<Kind: Hash + PortKind> Hash for PortIndex<Kind>

where Kind::ParamId: Hash, Kind::Listener: Hash,

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<T: PortKind> Index<PortIndex<T>> for Chunk

type Output = Block

The returned type after indexing.

fn index(&self, i: PortIndex<T>) -> &Block

Performs the indexing (container[index]) operation.

impl<T: PortKind> IndexMut<PortIndex<T>> for Chunk

fn index_mut(&mut self, i: PortIndex<T>) -> &mut Block

Performs the mutable indexing (container[index]) operation.

impl<Kind: Ord + PortKind> Ord for PortIndex<Kind>

where Kind::ParamId: Ord, Kind::Listener: Ord,

fn cmp(&self, other: &PortIndex<Kind>) -> 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<Kind: PartialEq + PortKind> PartialEq for PortIndex<Kind>

where Kind::ParamId: PartialEq, Kind::Listener: PartialEq,

fn eq(&self, other: &PortIndex<Kind>) -> 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<Kind: PartialOrd + PortKind> PartialOrd for PortIndex<Kind>

where Kind::ParamId: PartialOrd, Kind::Listener: PartialOrd,

fn partial_cmp(&self, other: &PortIndex<Kind>) -> 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<Kind: Copy + PortKind> Copy for PortIndex<Kind>

where Kind::ParamId: Copy, Kind::Listener: Copy,

impl<Kind: Eq + PortKind> Eq for PortIndex<Kind>

where Kind::ParamId: Eq, Kind::Listener: Eq,

impl<Kind: PortKind> StructuralPartialEq for PortIndex<Kind>