Enum GraphError 

pub enum GraphError {
    CycleDetected {
        nodes: Vec<NodeId>,
    },
    PortNotFound {
        node: NodeId,
        port: PortIdx,
    },
    PortDirectionMismatch {
        from: (NodeId, PortIdx),
        to: (NodeId, PortIdx),
    },
    PortIncompatible {
        from: (NodeId, PortIdx),
        to: (NodeId, PortIdx),
    },
    NotCompiled,
    AlreadyCompiled,
    NodeNotFound(NodeId),
}

Errors raised while building or compiling an audio Graph.

Every variant describes a construction- or compile-time failure. None of these errors can originate on the real-time thread: link validation and topological sorting both run in Graph::compile, and the only RT-path error is GraphError::NotCompiled (a single branch).

Variants

CycleDetected

The graph contains a cycle, so no valid processing order exists.

The accompanying node ids are those that remain after Kahn’s algorithm could make no further progress — i.e. the nodes participating in (or reachable into) the cycle.

Fields

nodes: Vec<NodeId>

Node ids that could not be ordered (part of / feeding a cycle).

PortNotFound

A referenced port does not exist on the named node.

Fields

node: NodeId

The node that was addressed.

port: PortIdx

The port index that does not exist.

PortDirectionMismatch

Two ports with incompatible directions were linked.

A valid edge connects an output port to an input port.

Fields

from: (NodeId, PortIdx)

The (node, port) that should have been an output.

to: (NodeId, PortIdx)

The (node, port) that should have been an input.

PortIncompatible

Two ports with mismatched channel counts or sample formats were linked.

Fields

from: (NodeId, PortIdx)

The upstream output (node, port).

to: (NodeId, PortIdx)

The downstream input (node, port).

NotCompiled

Graph::process_cycle was called before the graph was compiled.

AlreadyCompiled

Graph::compile was called on an already-compiled graph.

NodeNotFound(NodeId)

A referenced node id does not exist in the graph.

Trait Implementations

impl Clone for GraphError

fn clone(&self) -> GraphError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphError

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

Formats the value using the given formatter.

impl Display for GraphError

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

Formats the value using the given formatter.

impl Eq for GraphError

impl Error for GraphError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for GraphError

fn eq(&self, other: &GraphError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GraphError