Struct dynamic_graph::GraphPtr

#[repr(transparent)]
pub struct GraphPtr<'id, T> { /* fields omitted */ }

A checked pointer type used to access and traverse graph nodes in the crate. This pointer cannot be dereferenced directly and requires an anchor object to access the data stored in the collection. Thanks to 'generativity' crate this pointer can only be used with and created from an anchor branded with the same 'id and cannot be used once parent anchor is dropped.

Methods

impl<'id, T> GraphPtr<'id, T>

pub fn as_ptr(self) -> *const T

Returns a raw pointer to the graph node. This pointer should not be dereferenced directly and is meant to be a way to cache GraphPtrs between cleanups. You must ensure the node behind this pointer will not be deleted when the parent anchor is dropped

Trait Implementations

impl<'id, T> Clone for GraphPtr<'id, T>

fn clone(&self) -> GraphPtr<'id, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'id, T> Copy for GraphPtr<'id, T>

impl<'id, T: Eq> Eq for GraphPtr<'id, T>

impl<'id, T> Hash for GraphPtr<'id, 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, 

Feeds a slice of this type into the given [Hasher].

impl<'this, 'id: 'this, N: 'this, E: 'this, NodeType: 'this, Root: 'this> Index<GraphPtr<'id, NodeType>> for AnchorMut<'this, 'id, GenericGraph<Root, NodeType>> where
    NodeType: GraphNode<Node = N, Edge = E>, 

type Output = N

The returned type after indexing.

fn index(&self, dst: GraphPtr<'id, NodeType>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'this, 'id: 'this, N: 'this, E: 'this, NodeType: 'this, Root: 'this> IndexMut<GraphPtr<'id, NodeType>> for AnchorMut<'this, 'id, GenericGraph<Root, NodeType>> where
    NodeType: GraphNode<Node = N, Edge = E>, 

fn index_mut(&mut self, dst: GraphPtr<'id, NodeType>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'id, T> PartialEq<GraphPtr<'id, T>> for GraphPtr<'id, T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'id, T> StructuralEq for GraphPtr<'id, T>