Skip to main content

Arena

Struct Arena 

Source
pub struct Arena<T> { /* private fields */ }
Expand description

An append-only store of T nodes addressed by Id<T>.

Implementations§

Source§

impl<T> Arena<T>

Source

pub const fn new() -> Self

An empty arena.

Source

pub fn push(&mut self, value: T) -> Id<T>

Append a node and return its stable ID.

Source

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

Borrow the node with the given ID, or None when the ID is out of range (a dangling reference).

Source

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

Mutably borrow the node with the given ID, or None when the ID is out of range.

Source

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterate over all nodes in insertion order.

Source

pub fn len(&self) -> usize

The number of nodes.

Source

pub fn is_empty(&self) -> bool

Whether the arena is empty.

Source

pub fn contains(&self, id: Id<T>) -> bool

True when id is within this arena’s range (it may still refer to a node; see get).

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for Arena<T>

Source§

fn default() -> Arena<T>

Returns the “default value” for a type. Read more
Source§

impl<T: Eq> Eq for Arena<T>

Source§

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

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

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

Auto Trait Implementations§

§

impl<T> Freeze for Arena<T>
where Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for Arena<T>
where Vec<T>: RefUnwindSafe,

§

impl<T> Send for Arena<T>
where Vec<T>: Send,

§

impl<T> Sync for Arena<T>
where Vec<T>: Sync,

§

impl<T> Unpin for Arena<T>
where Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for Arena<T>
where Vec<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for Arena<T>
where Vec<T>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.