Struct Node

pub struct Node<V>
where
    V: Variant,
{ /* private fields */ }

Node of the self referential collection.

Implementations

impl<V> Node<V>

where V: Variant,

pub fn new_active(data: V::Item, prev: V::Prev, next: V::Next) -> Self

Creates a new active node with the given data, and prev and next references.

pub fn new_free_node(data: V::Item) -> Self

Creates a new active node with the given data but with no connections.

pub fn into_data(self) -> Option<V::Item>

Takes and returns the data of the node, transitions the node into the closed state.

pub fn data(&self) -> Option<&V::Item>

Returns a reference to the data of the node; None if the node is already closed.

pub fn prev(&self) -> &V::Prev

Returns a reference to the previous references.

pub fn next(&self) -> &V::Next

Returns a reference to the next references.

pub fn is_active(&self) -> bool

Returns true if the node is active, false if it is closed.

pub fn is_closed(&self) -> bool

Returns true if the node is closed, false if it is active.

pub fn data_mut(&mut self) -> Option<&mut V::Item>

Returns a mutable reference to the underlying data.

pub fn prev_mut(&mut self) -> &mut V::Prev

Returns a mutable reference to the previous references.

pub fn next_mut(&mut self) -> &mut V::Next

Returns a mutable reference to the next references.

pub fn close(&mut self) -> V::Item

Closes the node and returns its data, and clears its connections.

Panics

Panics if the node was already closed.

pub fn swap_data(&mut self, new_value: V::Item) -> V::Item

Swaps the data of the node with the new_value and returns the old value.

Panics

Panics if the node was already closed.

pub fn take_data(&mut self) -> Option<V::Item>

Closes the node and returns its data.

Panics

Panics if the node was already closed.

Trait Implementations

impl<V: Variant> Debug for Node<V>

where V::Item: Debug,

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

Formats the value using the given formatter.