pub struct SparseSet<I, V: 'static> { /* private fields */ }
Expand description
A data structure that blends dense and sparse storage
I
is the type of the indices, while V
is the type of data stored in the dense storage.
Implementations§
source§impl<I: SparseSetIndex, V> SparseSet<I, V>
impl<I: SparseSetIndex, V> SparseSet<I, V>
sourcepub fn contains(&self, index: I) -> bool
pub fn contains(&self, index: I) -> bool
Returns true
if the sparse set contains a value for index
.
sourcepub fn get(&self, index: I) -> Option<&V>
pub fn get(&self, index: I) -> Option<&V>
Returns a reference to the value for index
.
Returns None
if index
does not have a value in the sparse set.
sourcepub fn get_mut(&mut self, index: I) -> Option<&mut V>
pub fn get_mut(&mut self, index: I) -> Option<&mut V>
Returns a mutable reference to the value for index
.
Returns None
if index
does not have a value in the sparse set.
sourcepub fn indices(&self) -> impl Iterator<Item = I> + '_
pub fn indices(&self) -> impl Iterator<Item = I> + '_
Returns an iterator visiting all keys (indices) in arbitrary order.
sourcepub fn values(&self) -> impl Iterator<Item = &V>
pub fn values(&self) -> impl Iterator<Item = &V>
Returns an iterator visiting all values in arbitrary order.
sourcepub fn values_mut(&mut self) -> impl Iterator<Item = &mut V>
pub fn values_mut(&mut self) -> impl Iterator<Item = &mut V>
Returns an iterator visiting all values mutably in arbitrary order.
source§impl<I: SparseSetIndex, V> SparseSet<I, V>
impl<I: SparseSetIndex, V> SparseSet<I, V>
sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Creates a new SparseSet
with a specified initial capacity.
sourcepub fn capacity(&self) -> usize
pub fn capacity(&self) -> usize
Returns the total number of elements the SparseSet
can hold without needing to reallocate.
sourcepub fn insert(&mut self, index: I, value: V)
pub fn insert(&mut self, index: I, value: V)
Inserts value
at index
.
If a value was already present at index
, it will be overwritten.
sourcepub fn get_or_insert_with(
&mut self,
index: I,
func: impl FnOnce() -> V
) -> &mut V
pub fn get_or_insert_with( &mut self, index: I, func: impl FnOnce() -> V ) -> &mut V
Returns a reference to the value for index
, inserting one computed from func
if not already present.
Trait Implementations§
Auto Trait Implementations§
impl<I, V> Freeze for SparseSet<I, V>
impl<I, V> RefUnwindSafe for SparseSet<I, V>where
I: RefUnwindSafe,
V: RefUnwindSafe,
impl<I, V> Send for SparseSet<I, V>
impl<I, V> Sync for SparseSet<I, V>
impl<I, V> Unpin for SparseSet<I, V>
impl<I, V> UnwindSafe for SparseSet<I, V>where
I: UnwindSafe,
V: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.