bevy::ecs::entity::index_map

Struct Slice

pub struct Slice<V, S = EntityHash>(/* private fields */);

Expand description

A dynamically-sized slice of key-value pairs in an EntityIndexMap.

Equivalent to an indexmap::map::Slice<V> whose source IndexMap uses EntityHash.

Implementations§

Source §

impl<V> Slice<V>

Source

pub const fn new<'a>() -> &'a Slice<V>

Returns an empty slice.

Equivalent to map::Slice::new.

Source

pub fn new_mut<'a>() -> &'a mut Slice<V>

Returns an empty mutable slice.

Equivalent to map::Slice::new_mut.

Source

pub const unsafe fn from_slice_unchecked(slice: &Slice<Entity, V>) -> &Slice<V>

Constructs a entity::index_map::Slice from a indexmap::map::Slice unsafely.

§Safety

slice must stem from an IndexMap using EntityHash.

Source

pub const unsafe fn from_slice_unchecked_mut( slice: &mut Slice<Entity, V>, ) -> &mut Slice<V>

Constructs a entity::index_map::Slice from a indexmap::map::Slice unsafely.

§Safety

slice must stem from an IndexMap using EntityHash.

Source

pub const fn as_inner(&self) -> &Slice<Entity, V>

Casts self to the inner slice.

Source

pub unsafe fn from_boxed_slice_unchecked( slice: Box<Slice<Entity, V>>, ) -> Box<Slice<V>>

Constructs a boxed entity::index_map::Slice from a boxed indexmap::map::Slice unsafely.

§Safety

slice must stem from an IndexMap using EntityHash.

Source

pub fn as_boxed_inner(self: &Box<Slice<V>>) -> &Box<Slice<Entity, V>>

Casts a reference to self to the inner slice.

Source

pub fn into_boxed_inner(self: Box<Slice<V>>) -> Box<Slice<Entity, V>>

Casts self to the inner slice.

Source

pub fn get_index_mut(&mut self, index: usize) -> Option<(&Entity, &mut V)>

Get a key-value pair by index, with mutable access to the value.

Equivalent to map::Slice::get_index_mut.

Source

pub fn get_range<R>(&self, range: R) -> Option<&Slice<V>>
where R: RangeBounds<usize>,

Returns a slice of key-value pairs in the given range of indices.

Equivalent to map::Slice::get_range.

Source

pub fn get_range_mut<R>(&mut self, range: R) -> Option<&mut Slice<V>>
where R: RangeBounds<usize>,

Returns a mutable slice of key-value pairs in the given range of indices.

Equivalent to map::Slice::get_range_mut.

Source

pub fn first_mut(&mut self) -> Option<(&Entity, &mut V)>

Get the first key-value pair, with mutable access to the value.

Equivalent to map::Slice::first_mut.

Source

pub fn last_mut(&mut self) -> Option<(&Entity, &mut V)>

Get the last key-value pair, with mutable access to the value.

Equivalent to map::Slice::last_mut.

Source

pub fn split_at(&self, index: usize) -> (&Slice<V>, &Slice<V>)

Divides one slice into two at an index.

Equivalent to map::Slice::split_at.

Source

pub fn split_at_mut(&mut self, index: usize) -> (&mut Slice<V>, &mut Slice<V>)

Divides one mutable slice into two at an index.

Equivalent to map::Slice::split_at_mut.

Source

pub fn split_first(&self) -> Option<((&Entity, &V), &Slice<V>)>

Returns the first key-value pair and the rest of the slice, or None if it is empty.

Equivalent to map::Slice::split_first.

Source

pub fn split_first_mut(&mut self) -> Option<((&Entity, &mut V), &mut Slice<V>)>

Returns the first key-value pair and the rest of the slice, with mutable access to the value, or None if it is empty.

Equivalent to map::Slice::split_first_mut.

Source

pub fn split_last(&self) -> Option<((&Entity, &V), &Slice<V>)>

Returns the last key-value pair and the rest of the slice, or None if it is empty.

Equivalent to map::Slice::split_last.

Source

pub fn split_last_mut(&mut self) -> Option<((&Entity, &mut V), &mut Slice<V>)>

Returns the last key-value pair and the rest of the slice, with mutable access to the value, or None if it is empty.

Equivalent to map::Slice::split_last_mut.

Source

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

Return an iterator over the key-value pairs of the map slice.

Equivalent to map::Slice::iter.

Source

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

Return an iterator over the key-value pairs of the map slice.

Equivalent to map::Slice::iter_mut.

Source

pub fn keys(&self) -> Keys<'_, V> ⓘ

Return an iterator over the keys of the map slice.

Equivalent to map::Slice::keys.

Source

pub fn into_keys(self: Box<Slice<V>>) -> IntoKeys<V> ⓘ

Return an owning iterator over the keys of the map slice.

Equivalent to map::Slice::into_keys.

Source

pub fn values_mut(&mut self) -> ValuesMut<'_, Entity, V> ⓘ

Return an iterator over mutable references to the the values of the map slice.

Equivalent to map::Slice::values_mut.

Source

pub fn into_values(self: Box<Slice<V>>) -> IntoValues<Entity, V> ⓘ

Return an owning iterator over the values of the map slice.

Equivalent to map::Slice::into_values.

Methods from Deref<Target = Slice<Entity, V>>§

Source

pub fn len(&self) -> usize

Return the number of key-value pairs in the map slice.

Source

pub fn is_empty(&self) -> bool

Returns true if the map slice contains no elements.

Source

pub fn get_index(&self, index: usize) -> Option<(&K, &V)>

Get a key-value pair by index.

Valid indices are 0 <= index < self.len().

Source

pub fn get_range<R>(&self, range: R) -> Option<&Slice<K, V>>
where R: RangeBounds<usize>,

Returns a slice of key-value pairs in the given range of indices.

Valid indices are 0 <= index < self.len().

Source

pub fn first(&self) -> Option<(&K, &V)>

Get the first key-value pair.

Source

pub fn last(&self) -> Option<(&K, &V)>

Get the last key-value pair.

Source

pub fn split_at(&self, index: usize) -> (&Slice<K, V>, &Slice<K, V>)

Divides one slice into two at an index.

Panics if index > len.

Source

pub fn split_first(&self) -> Option<((&K, &V), &Slice<K, V>)>

Returns the first key-value pair and the rest of the slice, or None if it is empty.

Source

pub fn split_last(&self) -> Option<((&K, &V), &Slice<K, V>)>

Returns the last key-value pair and the rest of the slice, or None if it is empty.

Source

pub fn iter(&self) -> Iter<'_, K, V> ⓘ

Return an iterator over the key-value pairs of the map slice.

Source

pub fn keys(&self) -> Keys<'_, K, V> ⓘ

Return an iterator over the keys of the map slice.

Source

pub fn values(&self) -> Values<'_, K, V> ⓘ

Return an iterator over the values of the map slice.

Source

pub fn binary_search_keys(&self, x: &K) -> Result<usize, usize>
where K: Ord,

Search over a sorted map for a key.

Returns the position where that key is present, or the position where it can be inserted to maintain the sort. See slice::binary_search for more details.

Computes in O(log(n)) time, which is notably less scalable than looking the key up in the map this is a slice from using IndexMap::get_index_of, but this can also position missing keys.

Source

pub fn binary_search_by<'a, F>(&'a self, f: F) -> Result<usize, usize>
where F: FnMut(&'a K, &'a V) -> Ordering,

Search over a sorted map with a comparator function.

Returns the position where that value is present, or the position where it can be inserted to maintain the sort. See slice::binary_search_by for more details.

Computes in O(log(n)) time.

Source

pub fn binary_search_by_key<'a, B, F>( &'a self, b: &B, f: F, ) -> Result<usize, usize>
where F: FnMut(&'a K, &'a V) -> B, B: Ord,

Search over a sorted map with an extraction function.

Returns the position where that value is present, or the position where it can be inserted to maintain the sort. See slice::binary_search_by_key for more details.

Computes in O(log(n)) time.

Source