MapGraph

Struct MapGraph 

Source
pub struct MapGraph<NodeKey: Hash + Eq + Clone, NodeData: Clone, EdgeKey: Hash + Eq + Clone, EdgeData: Clone> { /* private fields */ }
Expand description

A directed graph that also maintains an arbitrary key-node and key-edge mapping

See module docs for more information

Implementations§

Source§

impl<NodeKey: Hash + Eq + Clone, NodeData: Clone, EdgeKey: Hash + Eq + Clone, EdgeData: Clone> MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source

pub fn new() -> Self

Create a new, empty, graph

Source

pub fn insert_node( &mut self, key: NodeKey, data: NodeData, ) -> Result<NodeMut<'_, NodeKey, NodeData, EdgeKey, EdgeData>, KeyAlreadyExists<NodeKey>>

Insert a node with the specified key and data

Returns a mutable reference to the new node

Source

pub fn get_node( &self, key: &NodeKey, ) -> Option<NodeRef<'_, NodeKey, NodeData, EdgeKey, EdgeData>>

Get a reference to the node with the specified key.

Returns None if there is no such node

Source

pub fn get_node_mut( &mut self, key: &NodeKey, ) -> Option<NodeMut<'_, NodeKey, NodeData, EdgeKey, EdgeData>>

Get a mutable reference to a node with the specified key

Returns None if there is no such node

Source

pub fn iter_nodes(&self) -> GraphNodes<'_, NodeKey, NodeData, EdgeKey, EdgeData>

Iterate over all nodes in the graph

Order is unspecified

Source

pub fn insert_edge( &mut self, from: NodeKey, to: NodeKey, key: EdgeKey, data: EdgeData, ) -> Result<EdgeMut<'_, NodeKey, NodeData, EdgeKey, EdgeData>, InsertEdgeError<NodeKey, EdgeKey>>

Insert a new edge between the specified nodes, with the specified key and data

Source

pub fn get_edge( &self, key: &EdgeKey, ) -> Option<EdgeRef<'_, NodeKey, NodeData, EdgeKey, EdgeData>>

Get a reference to the edge with the specified key

Returns None if there is no such edge

Source

pub fn get_edge_mut( &mut self, key: &EdgeKey, ) -> Option<EdgeMut<'_, NodeKey, NodeData, EdgeKey, EdgeData>>

Get a mutable reference to the edge with the specified key

Returns None if there is no such edge

Source

pub fn iter_edges(&self) -> GraphEdges<'_, NodeKey, NodeData, EdgeKey, EdgeData>

Iterate over all edges in the graph

Order is unspecified

Trait Implementations§

Source§

impl<NodeKey: Clone + Hash + Eq + Clone, NodeData: Clone + Clone, EdgeKey: Clone + Hash + Eq + Clone, EdgeData: Clone + Clone> Clone for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source§

fn clone(&self) -> MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

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<NodeKey: Debug + Hash + Eq + Clone, NodeData: Debug + Clone, EdgeKey: Debug + Hash + Eq + Clone, EdgeData: Debug + Clone> Debug for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source§

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

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

impl<NodeKey: Hash + Eq + Clone, NodeData: Clone, EdgeKey: Hash + Eq + Clone, EdgeData: Clone> Default for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source§

fn default() -> Self

The default: an empty graph

Source§

impl<NodeKey: Hash + Hash + Eq + Clone, NodeData: Hash + Clone, EdgeKey: Hash + Hash + Eq + Clone, EdgeData: Hash + Clone> Hash for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<NodeKey: PartialEq + Hash + Eq + Clone, NodeData: PartialEq + Clone, EdgeKey: PartialEq + Hash + Eq + Clone, EdgeData: PartialEq + Clone> PartialEq for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source§

fn eq(&self, other: &MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>) -> 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<NodeKey: Eq + Hash + Eq + Clone, NodeData: Eq + Clone, EdgeKey: Eq + Hash + Eq + Clone, EdgeData: Eq + Clone> Eq for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Source§

impl<NodeKey: Hash + Eq + Clone, NodeData: Clone, EdgeKey: Hash + Eq + Clone, EdgeData: Clone> StructuralPartialEq for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

Auto Trait Implementations§

§

impl<NodeKey, NodeData, EdgeKey, EdgeData> Freeze for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>

§

impl<NodeKey, NodeData, EdgeKey, EdgeData> RefUnwindSafe for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>
where NodeKey: RefUnwindSafe, NodeData: RefUnwindSafe, EdgeKey: RefUnwindSafe, EdgeData: RefUnwindSafe,

§

impl<NodeKey, NodeData, EdgeKey, EdgeData> Send for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>
where NodeKey: Send + Sync, NodeData: Send + Sync, EdgeKey: Send + Sync, EdgeData: Send + Sync,

§

impl<NodeKey, NodeData, EdgeKey, EdgeData> Sync for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>
where NodeKey: Sync + Send, NodeData: Sync + Send, EdgeKey: Sync + Send, EdgeData: Sync + Send,

§

impl<NodeKey, NodeData, EdgeKey, EdgeData> Unpin for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>
where NodeKey: Unpin, NodeData: Unpin, EdgeKey: Unpin, EdgeData: Unpin,

§

impl<NodeKey, NodeData, EdgeKey, EdgeData> UnwindSafe for MapGraph<NodeKey, NodeData, EdgeKey, EdgeData>
where NodeKey: UnwindSafe + RefUnwindSafe, NodeData: UnwindSafe + RefUnwindSafe, EdgeKey: UnwindSafe + RefUnwindSafe, EdgeData: UnwindSafe + RefUnwindSafe,

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> Same for T

Source§

type Output = T

Should always be Self
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.