Struct CoreCol

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

Core collection of the self referential collection.

Implementations

impl<V, P> CoreCol<V, P>

where V: Variant, P: PinnedVec<Node<V>>,

pub fn new() -> Self

where P: Default,

Creates a new empty collection.

pub fn into_inner(self) -> (P, V::Ends, usize)

Destructs the collection into its inner pinned vec, ends and length.

pub fn utilization(&self) -> Utilization

Returns current node utilization of the collection.

pub fn len(&self) -> usize

Returns length of the self referential collection.

pub fn is_empty(&self) -> bool

Returns whether or not the self referential collection is empty.

pub fn nodes(&self) -> &P

Returns a reference to the underlying nodes storage.

pub fn node(&self, node_ptr: &NodePtr<V>) -> &Node<V>

Returns a reference to the node with the given node_ptr.

pub fn position_of(&self, node_ptr: &NodePtr<V>) -> Option<usize>

Returns the position of the node with the given node_ptr, None if the pointer is not valid.

pub fn position_of_unchecked(&self, node_ptr: &NodePtr<V>) -> usize

Returns the position of the node with the given node_ptr.

Panics

Panics if the pointer is not valid.

pub unsafe fn data_unchecked(&self, node_ptr: &NodePtr<V>) -> &V::Item

Returns a reference to the data.

Panics

Panics if the node is already closed.

Safety

Does not perform bounds check; hence, the caller must guarantee that the node_ptr belongs to (created from) this collection.

pub fn ends(&self) -> &V::Ends

Returns a reference to the ends of the collection.

pub fn node_ptr_at_pos(&self, node_position: usize) -> NodePtr<V>

Returns the pointer of the element with the given node_position in the underlying nodes storage.

Panics

Panics if the node_position is out of bounds.

pub fn nodes_mut(&mut self) -> &mut P

Returns a mutable reference to the underlying nodes storage.

pub fn push(&mut self, data: V::Item) -> NodePtr<V>

Pushes the element with the given data and returns its pointer.

pub unsafe fn data_mut_unchecked( &mut self, node_ptr: &NodePtr<V>, ) -> &mut V::Item

Returns a mutable reference to the data.

Panics

Panics if the node is already closed.

Safety

Does not perform bounds check; hence, the caller must guarantee that the node_ptr belongs to (created from) this collection.

pub fn close(&mut self, node_ptr: &NodePtr<V>) -> V::Item

Closes the node at the given node_ptr and returns its data.

Panics

Panics if the node was already closed.

pub fn close_if_active(&mut self, node_ptr: &NodePtr<V>) -> Option<V::Item>

Closes the node at the given node_ptr and returns its data the node was active. Does nothing and returns None if the node was already closed.

pub fn ends_mut(&mut self) -> &mut V::Ends

Returns a mutable reference to the ends of the collection.

pub fn node_mut(&mut self, node_ptr: &NodePtr<V>) -> &mut Node<V>

Returns a mutable reference to the node with the given node_ptr.

pub fn move_node(&mut self, closed_position: usize, active_position: usize)

Swaps the closed node at the closed_position with the active node at the active_position.

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

Swaps the underlying data of the element at the given node_ptr with the new_value, and returns the old value.

Panics

Panics if the node was already closed.

impl<V> CoreCol<V, SplitVec<Node<V>, Recursive>>

where V: Variant,

pub fn append_nodes(&mut self, nodes: SplitVec<Node<V>, Recursive>)

Appends the nodes to this collection.

Trait Implementations

impl<V, P> Default for CoreCol<V, P>

where V: Variant, P: PinnedVec<Node<V>> + Default,

fn default() -> Self

Returns the “default value” for a type.