Enum NodeIdxError

pub enum NodeIdxError {
    RemovedNode,
    OutOfBounds,
    ReorganizedCollection,
}

Error cases of an invalid node index.

Variants

RemovedNode

RemovedNode => Referenced node is removed from the collection. Node index can only be used if the corresponding node still belongs to the collection.

OutOfBounds

OutOfBounds => Node index is does not point to the current nodes of the collection. This might be due to either of the following:

• the index is being used to access a collection which is different than which it was created for,
• the node that the index is pointing to does not belong to the collection any more due to shrinking of the collection.

ReorganizedCollection

ReorganizedCollection => Nodes of the containing collection is re-organized in order to reclaim memory of closed nodes. Such a reorganization happens:

• after a node removal if the utilization level drops below a threshold on default self-reorganizing memory policies,
• after every removal if the always-reclaim memory is used,
• only if the reclaim_closed_nodes() is manually called when never-reclaim policy is used,
  • note that in this case indices are never implicitly invalidated.

Trait Implementations

impl Clone for NodeIdxError

fn clone(&self) -> NodeIdxError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeIdxError

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

Formats the value using the given formatter.

impl Display for NodeIdxError

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

Formats the value using the given formatter.

impl From<NodeIdxError> for NodeSwapError

fn from(value: NodeIdxError) -> Self

Converts to this type from the input type.

impl PartialEq for NodeIdxError

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NodeIdxError

impl Eq for NodeIdxError

impl StructuralPartialEq for NodeIdxError