Method remove_node

crates/firewheel-graph/src/graph.rs:258–301

Remove the given node from the audio graph. This will automatically remove all edges from the graph that were connected to this node. On success, this returns a list of all edges that were removed from the graph as a result of removing this node. This will return an error if the ID is of the graph input or graph output node.

(
        &mut self,
        node_id: NodeID,
        is_restoring_graph_state: bool,
    )

    /// This will return an error if the ID is of the graph input or graph
    /// output node.
    pub fn remove_node(
        &mut self,
        node_id: NodeID,
        is_restoring_graph_state: bool,
    ) -> Result<SmallVec<[Edge; 4]>, RemoveNodeError> {
        if node_id == self.graph_in_id {
            return Err(RemoveNodeError::CannotRemoveGraphInNode);
        }
        if node_id == self.graph_out_id {
            return Err(RemoveNodeError::CannotRemoveGraphOutNode);
        }

        let mut removed_edges = SmallVec::new();

        let Some(node_entry) = self.nodes.remove(node_id.0) else {
            return Ok(removed_edges);
        };

        for port_idx in 0..node_entry.info.channel_config.num_inputs.get() {
            removed_edges.append(&mut self.remove_edges_with_input_port(
                node_id,
                port_idx,
                is_restoring_graph_state,
            ));
        }
        for port_idx in 0..node_entry.info.channel_config.num_outputs.get() {
            removed_edges.append(&mut self.remove_edges_with_output_port(
                node_id,
                port_idx,
                is_restoring_graph_state,
            ));
        }

        self.needs_compile = true;

        if !is_restoring_graph_state && let Some(guard) = self.modify_guard_stack.last_mut() {
            guard.removed_nodes.push(node_entry);
        } else {
            self.nodes_to_remove_from_schedule.push(node_id);
            self.active_nodes_to_remove.insert(node_id, node_entry);
        }

        Ok(removed_edges)
    }

    /// Get information about a node in the graph.
    pub fn node_info(&self, id: NodeID) -> Option<&NodeEntry> {