Skip to main content

NodeGraph

Struct NodeGraph 

Source
pub struct NodeGraph<N, E> { /* private fields */ }
Expand description

Pure node graph data model with typed ports.

Implementations§

Source§

impl<N, E> NodeGraph<N, E>

Source

pub fn new() -> Self

Creates an empty graph.

Source

pub fn add_node(&mut self, payload: N) -> NodeId

Adds a node without ports and returns its identifier.

Source

pub fn add_node_with_ports(&mut self, payload: N, ports: Vec<Port>) -> NodeId

Adds a node with declared ports and returns its identifier.

Source

pub fn remove_node(&mut self, id: NodeId) -> Result<Node<N>, GraphError>

Removes a node and all connected edges.

Source

pub fn add_edge( &mut self, from: (NodeId, PortId), to: (NodeId, PortId), payload: E, ) -> Result<EdgeId, GraphError>

Adds a validated directed edge between two ports.

Source

pub fn remove_edge(&mut self, id: EdgeId) -> Result<Edge<E>, GraphError>

Removes an edge by identifier.

Source

pub fn node(&self, id: NodeId) -> Option<&Node<N>>

Returns an immutable node reference.

Source

pub fn node_mut(&mut self, id: NodeId) -> Option<&mut Node<N>>

Returns a mutable node reference.

Source

pub fn edge(&self, id: EdgeId) -> Option<&Edge<E>>

Returns an immutable edge reference.

Source

pub fn nodes(&self) -> impl Iterator<Item = (&NodeId, &Node<N>)>

Iterates over nodes in identifier order.

Source

pub fn edges(&self) -> impl Iterator<Item = (&EdgeId, &Edge<E>)>

Iterates over edges in identifier order.

Source

pub fn connected(&self, port: (NodeId, PortId)) -> Vec<EdgeId>

Returns all edges connected to the given port.

Source

pub fn incoming(&self, node: NodeId) -> Vec<EdgeId>

Returns all incoming edge identifiers for a node.

Source

pub fn outgoing(&self, node: NodeId) -> Vec<EdgeId>

Returns all outgoing edge identifiers for a node.

Trait Implementations§

Source§

impl<N: Clone, E: Clone> Clone for NodeGraph<N, E>

Source§

fn clone(&self) -> NodeGraph<N, E>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<N: Debug, E: Debug> Debug for NodeGraph<N, E>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<N, E> Default for NodeGraph<N, E>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<N: PartialEq, E: PartialEq> PartialEq for NodeGraph<N, E>

Source§

fn eq(&self, other: &NodeGraph<N, E>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<N: Eq, E: Eq> Eq for NodeGraph<N, E>

Source§

impl<N, E> StructuralPartialEq for NodeGraph<N, E>

Auto Trait Implementations§

§

impl<N, E> Freeze for NodeGraph<N, E>

§

impl<N, E> RefUnwindSafe for NodeGraph<N, E>

§

impl<N, E> Send for NodeGraph<N, E>
where N: Send, E: Send,

§

impl<N, E> Sync for NodeGraph<N, E>
where N: Sync, E: Sync,

§

impl<N, E> Unpin for NodeGraph<N, E>

§

impl<N, E> UnsafeUnpin for NodeGraph<N, E>

§

impl<N, E> UnwindSafe for NodeGraph<N, E>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.