Struct Node 

pub struct Node<T: Neighbors> { /* private fields */ }

An owning shared reference to a node.

This “anchors” the entire connected graph to the memory. In order to avoid cyclic ownership i.e. memory leaks, T should not contain references to other nodes through this type. If dropped, and no other Nodes to any single connected node are held elsewhere, the connected nodes will be dropped as well.

Returned by Node::new and Internode::upgrade.

Implementations

impl<T: Neighbors> Node<T>

pub fn new(value: T) -> Self

Creates a new Node with the given value.

pub fn downgrade(&self) -> Internode<T>

Downgrades this Node into an Internode.

pub fn lock(&self) -> InternodeMutexGuard<'_, T>

Blocks until the internal Mutex can be locked and returns a guard to the value.

Methods from Deref<Target = Internode<T>>

pub fn lock(&self) -> Option<InternodeMutexGuard<'_, T>>

Blocks until the internal Mutex can be locked and returns a guard to the value. Will be None if this Internode is dropped already.

pub fn upgrade(&self) -> Option<Node<T>>

Tries to anchor this Internode into a Node.

pub fn outgoing(&self) -> impl '_ + Iterator<Item = Self>

Blocks until the internal Mutex can be locked and calls Neighbors::outgoing.

pub fn incoming(&self) -> impl '_ + Iterator<Item = Self>

Blocks until the internal Mutex can be locked and calls Neighbors::incoming.

pub fn dfs_outgoing(&self) -> impl '_ + Iterator<Item = Self>

Performs a depth-first search by recursively calling Internode::outgoing. Includes the starting node first.

pub fn dfs_incoming(&self) -> impl '_ + Iterator<Item = Self>

Performs a depth-first search by recursively calling Internode::incoming. Includes the starting node first.

pub fn bfs_outgoing(&self) -> impl '_ + Iterator<Item = Self>

Performs a breadth-first search by recursively calling Internode::outgoing. Includes the starting node first.

pub fn bfs_incoming(&self) -> impl '_ + Iterator<Item = Self>

Performs a breadth-first search by recursively calling Internode::incoming. Includes the starting node first.

Trait Implementations

impl<T: Neighbors> Clone for Node<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Neighbors + Debug> Debug for Node<T>

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

Formats the value using the given formatter.

impl<T: Neighbors> Deref for Node<T>

type Target = Internode<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Neighbors + Display> Display for Node<T>

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

Formats the value using the given formatter.

impl<T: Neighbors> Hash for Node<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Neighbors> PartialEq for Node<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Neighbors> Eq for Node<T>