Trait PortView

Source

pub trait PortView {
    type PortOffsetBase: Unsigned;

Show 27 methods    // Required methods
    fn port_direction(&self, port: impl Into<PortIndex>) -> Option<Direction>;
    fn port_node(&self, port: impl Into<PortIndex>) -> Option<NodeIndex>;
    fn port_offset(
        &self,
        port: impl Into<PortIndex>,
    ) -> Option<PortOffset<Self::PortOffsetBase>>;
    fn port_index(
        &self,
        node: NodeIndex,
        offset: PortOffset<Self::PortOffsetBase>,
    ) -> Option<PortIndex>;
    fn ports(
        &self,
        node: NodeIndex,
        direction: Direction,
    ) -> impl Iterator<Item = PortIndex> + Clone;
    fn all_ports(
        &self,
        node: NodeIndex,
    ) -> impl Iterator<Item = PortIndex> + Clone;
    fn input(&self, node: NodeIndex, offset: usize) -> Option<PortIndex>;
    fn output(&self, node: NodeIndex, offset: usize) -> Option<PortIndex>;
    fn num_ports(&self, node: NodeIndex, direction: Direction) -> usize;
    fn port_offsets(
        &self,
        node: NodeIndex,
        direction: Direction,
    ) -> impl Iterator<Item = PortOffset<Self::PortOffsetBase>> + Clone;
    fn all_port_offsets(
        &self,
        node: NodeIndex,
    ) -> impl Iterator<Item = PortOffset<Self::PortOffsetBase>> + Clone;
    fn contains_node(&self, node: NodeIndex) -> bool;
    fn contains_port(&self, port: PortIndex) -> bool;
    fn is_empty(&self) -> bool;
    fn node_count(&self) -> usize;
    fn port_count(&self) -> usize;
    fn nodes_iter(&self) -> impl Iterator<Item = NodeIndex> + Clone;
    fn ports_iter(&self) -> impl Iterator<Item = PortIndex> + Clone;
    fn node_capacity(&self) -> usize;
    fn port_capacity(&self) -> usize;
    fn node_port_capacity(&self, node: NodeIndex) -> usize;

    // Provided methods
    fn inputs(&self, node: NodeIndex) -> impl Iterator<Item = PortIndex> + Clone { ... }
    fn outputs(
        &self,
        node: NodeIndex,
    ) -> impl Iterator<Item = PortIndex> + Clone { ... }
    fn num_inputs(&self, node: NodeIndex) -> usize { ... }
    fn num_outputs(&self, node: NodeIndex) -> usize { ... }
    fn input_offsets(
        &self,
        node: NodeIndex,
    ) -> impl Iterator<Item = PortOffset<Self::PortOffsetBase>> + Clone { ... }
    fn output_offsets(
        &self,
        node: NodeIndex,
    ) -> impl Iterator<Item = PortOffset<Self::PortOffsetBase>> + Clone { ... }
}

Expand description

Core capabilities for querying a graph containing nodes and ports.

Required Associated Types§

Source

type PortOffsetBase: Unsigned

The base unsigned integer type for port offsets.

Required Methods§

Source

fn port_direction(&self, port: impl Into<PortIndex>) -> Option<Direction>

Returns the direction of the port.

Source

fn port_node(&self, port: impl Into<PortIndex>) -> Option<NodeIndex>

Returns the node that the port belongs to.

Source

fn port_offset( &self, port: impl Into<PortIndex>, ) -> Option<PortOffset<Self::PortOffsetBase>>

Returns the index of a port within its node’s port list.

Source

fn port_index( &self, node: NodeIndex, offset: PortOffset<Self::PortOffsetBase>, ) -> Option<PortIndex>

Returns the port index for a given node and offset.

Source

fn ports( &self, node: NodeIndex, direction: Direction, ) -> impl Iterator<Item = PortIndex> + Clone

Iterates over all the ports of the node in the given direction.

Source

fn all_ports(&self, node: NodeIndex) -> impl Iterator<Item = PortIndex> + Clone

Iterates over the input and output ports of the node in sequence.

Source

fn input(&self, node: NodeIndex, offset: usize) -> Option<PortIndex>

Returns the input port at the given offset in the node.

Shorthand for PortView::port_index.

Source

fn output(&self, node: NodeIndex, offset: usize) -> Option<PortIndex>

Returns the output port at the given offset in the node.

Shorthand for PortView::port_index.

Source

fn num_ports(&self, node: NodeIndex, direction: Direction) -> usize

Returns the number of ports of the node in the given direction.

Source

fn port_offsets( &self, node: NodeIndex, direction: Direction, ) -> impl Iterator<Item = PortOffset<Self::PortOffsetBase>> + Clone

Iterates over all the port offsets of the node in the given direction.

§Example

let mut graph: PortGraph = PortGraph::new();
let node = graph.add_node(0, 2);

assert!(graph.links(node, Direction::Incoming).eq([]));
assert!(graph.port_offsets(node, Direction::Outgoing).eq([PortOffset::new_outgoing(0), PortOffset::new_outgoing(1)]));

Source