Struct DenseHandleMap 

pub struct DenseHandleMap<T> { /* private fields */ }

Implementations

impl<T> DenseHandleMap<T>

pub const fn new() -> Self

pub fn len(&self) -> usize

Returns the number values in the map.

pub fn capacity(&self) -> usize

Returns the total number of elements the map can hold without reallocating.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn get(&self, handle: Handle<T>) -> Option<&T>

Returns a reference to the value associated with handle.

Returns None if the value does not exist.

pub fn get_mut(&mut self, handle: Handle<T>) -> Option<&mut T>

Returns a mutable reference to the value associated with handle.

Returns None if the value does not exist.

pub fn insert(&mut self, value: T) -> Handle<T>

Inserts value into the map, returning a Handle to its location.

Panics

Panics if the new capacity exceeds u32::MAX bytes.

pub fn predict_next_handle(&self) -> Handle<T>

Predicts the next handle that will be generated.

This is just an alias for predict_handle(0).

Panics

This function will panic if the predicted capacity exceeds u32::MAX

pub fn predict_handle(&self, count: usize) -> Handle<T>

Predicts the handle that will be generated after inserting count values.

This is only accurate for multiple inserts. Once a single removal is made, this prediction can de-sync.

Panics

This function will panic if the predicted capacity exceeds u32::MAX

pub fn remove(&mut self, handle: Handle<T>) -> Option<T>

Removes the value associated with handle from the map.

Returns None if the value does not exist.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator that yields all value refrences in the map and their associated Handle.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns an iterator that yields all mutable value refrences in the map and their associated Handle.

pub fn handles(&self) -> Handles<'_, T>

Returns an iterator that yields every valid value Handle in the map.

pub fn values(&self) -> Values<'_, T>

Returns an iterator that yields all value refrences in the map.

pub fn values_mut(&mut self) -> ValuesMut<'_, T>

Returns an iterator that yields all mutable value refrences in the map.

Trait Implementations

impl<T: Clone> Clone for DenseHandleMap<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DenseHandleMap<T>

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

Formats the value using the given formatter.

impl<T> Default for DenseHandleMap<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Hash> Hash for DenseHandleMap<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<Handle<T>> for DenseHandleMap<T>

type Output = T

The returned type after indexing.

fn index(&self, handle: Handle<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Handle<T>> for DenseHandleMap<T>

fn index_mut(&mut self, handle: Handle<T>) -> &mut Self::Output

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

impl<T: Ord> Ord for DenseHandleMap<T>

fn cmp(&self, other: &DenseHandleMap<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for DenseHandleMap<T>

fn eq(&self, other: &DenseHandleMap<T>) -> 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<T: PartialOrd> PartialOrd for DenseHandleMap<T>

fn partial_cmp(&self, other: &DenseHandleMap<T>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Eq> Eq for DenseHandleMap<T>

impl<T> StructuralPartialEq for DenseHandleMap<T>