Struct indextree::Arena

pub struct Arena<T> { /* fields omitted */ }

An Arena structure containing certain Nodes

Methods

impl<T> Arena<T>

pub fn new() -> Arena<T>

Create a new empty Arena

pub fn new_node(&mut self, data: T) -> NodeId

Create a new node from its associated data.

Panics

Panics if the arena already has usize::max_value() nodes.

pub fn count(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get(&self, id: NodeId) -> Option<&Node<T>>

Get a reference to the node with the given id if in the arena, None otherwise.

pub fn get_mut(&mut self, id: NodeId) -> Option<&mut Node<T>>

Get a mutable reference to the node with the given id if in the arena, None otherwise.

pub fn iter(&self) -> Iter<Node<T>>

Iterate over all nodes in the arena in storage-order.

Note that this iterator also contains removed elements, which can be tested with the is_removed() method on the node.

Trait Implementations

impl<T: PartialEq> PartialEq<Arena<T>> for Arena<T>

fn eq(&self, other: &Arena<T>) -> bool

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

fn ne(&self, other: &Arena<T>) -> bool

This method tests for !=.

impl<T: Clone> Clone for Arena<T>

fn clone(&self) -> Arena<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Index<NodeId> for Arena<T>

type Output = Node<T>

The returned type after indexing.

fn index(&self, node: NodeId) -> &Node<T>

Performs the indexing (container[index]) operation.

impl<T> IndexMut<NodeId> for Arena<T>

fn index_mut(&mut self, node: NodeId) -> &mut Node<T>

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

impl<T: Debug> Debug for Arena<T>

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

Formats the value using the given formatter.