Struct PortId 

pub struct PortId { /* private fields */ }

Unique identifier for a port within a graph

Implementations

impl PortId

pub const fn new( node: NodeId, port_type: PortType, direction: PortDirection, index: u16, ) -> PortId

Create a new port ID

pub const fn audio_in(node: NodeId, index: u16) -> PortId

Create a new signal input port

pub const fn audio_out(node: NodeId, index: u16) -> PortId

Create a new signal output port

pub const fn control_in(node: NodeId, index: u16) -> PortId

Create a new control input port

pub const fn control_out(node: NodeId, index: u16) -> PortId

Create a new control output port

pub const fn clock_in(node: NodeId, index: u16) -> PortId

Create a new clock input port

pub const fn clock_out(node: NodeId, index: u16) -> PortId

Create a new clock output port

pub const fn feedback_in(node: NodeId, index: u16) -> PortId

Create a new feedback input port

pub const fn feedback_out(node: NodeId, index: u16) -> PortId

Create a new feedback output port

pub const fn param(node: NodeId, index: u16) -> PortId

Create a new parameter port (always input)

pub const fn node_id(&self) -> NodeId

Get the node ID

pub const fn port_type(&self) -> PortType

Get the port type

pub const fn direction(&self) -> PortDirection

Get the port direction

pub const fn index(&self) -> u16

Get the port index

pub const fn is_input(&self) -> bool

Check if this is an input port

pub const fn is_output(&self) -> bool

Check if this is an output port

pub const fn is_audio(&self) -> bool

Check if this is an audio port

pub const fn is_control(&self) -> bool

Check if this is a control port

pub const fn is_clock(&self) -> bool

Check if this is a clock port

pub const fn is_feedback(&self) -> bool

Check if this is a feedback port

pub const fn is_param(&self) -> bool

Check if this is a parameter port

Trait Implementations

impl Clone for PortId

fn clone(&self) -> PortId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortId

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

Formats the value using the given formatter.

impl Display for PortId

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

Formats the value using the given formatter.

impl Hash for PortId

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

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

impl Eq for PortId

impl StructuralPartialEq for PortId