Struct dynamic_graph::AnchorMut

pub struct AnchorMut<'this, 'id: 'this, T: 'this> { /* fields omitted */ }

Methods

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

pub unsafe fn gptr_from_ptr(
    &self,
    raw: *const NodeType
) -> GraphPtr<'id, NodeType>

Creates a checked pointer from a raw pointer

Safety

Caller must guarantee raw points to a node which was not cleaned up and belongs to the parent graph

pub fn cursor(&self, dst: GraphPtr<'id, NodeType>) -> Cursor<'_, 'id, NodeType>

Creates an immutable cursor pointing to dst

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

pub fn spawn_detached(&mut self, payload: N) -> GraphPtr<'id, NodeType>

Allocates a new node and returns the pointer. This node will become inaccessible when parent anchor is dropped and will be disposed of upon next cleanup unless you attach it to root or another node accessible from the root.

pub fn cursor_mut(
    &mut self,
    dst: GraphPtr<'id, NodeType>
) -> CursorMut<'_, 'id, NodeType>

Creates a mutable cursor pointing to dst.

impl<'this, 'id: 'this, N: 'this, E: 'this, Root: 'this> AnchorMut<'this, 'id, GenericGraph<Root, NamedNode<N, E>>>

pub fn connect(
    &mut self,
    src: GraphPtr<'id, NamedNode<N, E>>,
    dst: GraphPtr<'id, NamedNode<N, E>>,
    edge: E
)

Creates an edge from src to dst with the value edge.

pub fn disconnect(
    &mut self,
    src: GraphPtr<'id, NamedNode<N, E>>,
    dst: GraphPtr<'id, NamedNode<N, E>>
)

Removes an edge from src to dst.

pub fn view(&self, dst: GraphPtr<'id, NamedNode<N, E>>) -> &NamedNode<'id, N, E>

Provides direct access to the contents of the dst node. !!! Relies on undefined behavior and should not be used !!!

pub fn view_mut(
    &mut self,
    dst: GraphPtr<'id, NamedNode<N, E>>
) -> &mut NamedNode<'id, N, E>

Provides mutable direct access to the contents of the dst node. !!! Relies on undefined behavior and should not be used !!!

impl<'this, 'id: 'this, N: 'this, E: 'this, NodeType: 'this> AnchorMut<'this, 'id, VecGraph<NodeType>> where
    NodeType: GraphNode<Node = N, Edge = E>, 

pub fn spawn(&mut self, payload: N) -> GraphPtr<'id, NodeType>

Allocates a new node and returns the pointer. Attaches the node to the root.

pub fn root(&self) -> &Vec<GraphPtr<'id, NodeType>>

Provides safe direct access to the collection of the root. !!! Relies on undefined behavior and should not be used !!!

pub fn root_mut(&mut self) -> &mut Vec<GraphPtr<'id, NodeType>>

Provides safe mutable direct access to the collection of the root. !!! Relies on undefined behavior and should not be used !!!

pub fn attach(&mut self, dst: GraphPtr<'id, NodeType>)

Attaches dst to the root using Vec::push.

pub fn detach(&mut self, index: usize)

Detaches a node from the root using Vec::swap_remove.

pub fn iter(&self) -> impl Iterator<Item = (&N, GraphPtr<'id, NodeType>)>

Returns an iterator over payloads and node pointers attached to the root.

pub fn iter_mut(
    &mut self
) -> impl Iterator<Item = (&mut N, GraphPtr<'id, NodeType>)>

Returns a mutable iterator over payloads and node pointers attached to the root.

Trait Implementations

impl<'this, 'id: 'this, T: 'this> Drop for AnchorMut<'this, 'id, T>

fn drop(&mut self)

Executes the destructor for this type.

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.