Struct compact_arena::Idx

pub struct Idx<'tag, I: Copy + Clone> { /* fields omitted */ }

An index into the arena. You will not directly use this type, but one of the aliases this crate provides (Idx32, Idx16 or Idx8).

The only way to get an index into an arena is to add a value to it. With an Idx you can index or mutably index into the arena to observe or mutate the value.

Trait Implementations

impl<'tag, I: Clone + Copy> Clone for Idx<'tag, I>

fn clone(&self) -> Idx<'tag, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tag, I: Copy + Clone> Copy for Idx<'tag, I>

impl<'tag, I: Eq + Copy + Clone> Eq for Idx<'tag, I>

impl<'tag, T> Index<Idx<'tag, u16>> for TinyArena<'tag, T>

type Output = T

The returned type after indexing.

fn index(&self, i: Idx16<'tag>) -> &T

Performs the indexing (container[index]) operation.

impl<'tag, T> Index<Idx<'tag, u32>> for SmallArena<'tag, T>

type Output = T

The returned type after indexing.

fn index(&self, i: Idx32<'tag>) -> &T

Gets an immutable reference to the value at this index.

impl<'tag, T> Index<Idx<'tag, u8>> for NanoArena<'tag, T>

type Output = T

The returned type after indexing.

fn index(&self, i: Idx8<'tag>) -> &T

Performs the indexing (container[index]) operation.

impl<'tag, T> IndexMut<Idx<'tag, u16>> for TinyArena<'tag, T>

fn index_mut(&mut self, i: Idx16<'tag>) -> &mut T

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

impl<'tag, T> IndexMut<Idx<'tag, u32>> for SmallArena<'tag, T>

fn index_mut(&mut self, i: Idx32<'tag>) -> &mut T

Gets a mutable reference to the value at this index.

impl<'tag, T> IndexMut<Idx<'tag, u8>> for NanoArena<'tag, T>

fn index_mut(&mut self, i: Idx8<'tag>) -> &mut T

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

impl<'tag, I: PartialEq + Copy + Clone> PartialEq<Idx<'tag, I>> for Idx<'tag, I>

fn eq(&self, other: &Idx<'tag, I>) -> bool

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

fn ne(&self, other: &Idx<'tag, I>) -> bool

This method tests for !=.

impl<'tag, I: PartialOrd + Copy + Clone> PartialOrd<Idx<'tag, I>> for Idx<'tag, I>

fn partial_cmp(&self, other: &Idx<'tag, I>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Idx<'tag, I>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Idx<'tag, I>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Idx<'tag, I>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Idx<'tag, I>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'tag, I: Copy + Clone> StructuralEq for Idx<'tag, I>

impl<'tag, I: Copy + Clone> StructuralPartialEq for Idx<'tag, I>