Struct Slice

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

A dynamically-sized slice of values in an EntityIndexSet.

Equivalent to an indexmap::set::Slice<V> whose source IndexSet uses EntityHash.

Implementations

impl Slice

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

Returns an empty slice.

Equivalent to set::Slice::new.

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

Constructs a entity::index_set::Slice from a indexmap::set::Slice unsafely.

Safety

slice must stem from an IndexSet using EntityHash.

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

Constructs a entity::index_set::Slice from a indexmap::set::Slice unsafely.

Safety

slice must stem from an IndexSet using EntityHash.

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

Casts self to the inner slice.

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

Constructs a boxed entity::index_set::Slice from a boxed indexmap::set::Slice unsafely.

Safety

slice must stem from an IndexSet using EntityHash.

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

Casts a reference to self to the inner slice.

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

Casts self to the inner slice.

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

where R: RangeBounds<usize>,

Returns a slice of values in the given range of indices.

Equivalent to set::Slice::get_range.

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

Divides one slice into two at an index.

Equivalent to set::Slice::split_at.

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

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

Equivalent to set::Slice::split_first.

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

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

Equivalent to set::Slice::split_last.

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

Return an iterator over the values of the set slice.

Equivalent to set::Slice::iter.

Methods from Deref<Target = Slice<Entity>>

pub fn len(&self) -> usize

Return the number of elements in the set slice.

pub fn is_empty(&self) -> bool

Returns true if the set slice contains no elements.

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

Get a value by index.

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

pub fn get_range<R>(&self, range: R) -> Option<&Slice<T>>

where R: RangeBounds<usize>,

Returns a slice of values in the given range of indices.

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

pub fn first(&self) -> Option<&T>

Get the first value.

pub fn last(&self) -> Option<&T>

Get the last value.

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

Divides one slice into two at an index.

Panics if index > len.

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

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

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

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

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

Return an iterator over the values of the set slice.

pub fn binary_search(&self, x: &T) -> Result<usize, usize>

where T: Ord,

Search over a sorted set for a value.

Returns the position where that value 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 value up in the set this is a slice from using IndexSet::get_index_of, but this can also position missing values.

pub fn binary_search_by<'a, F>(&'a self, f: F) -> Result<usize, usize>

where F: FnMut(&'a T) -> Ordering,

Search over a sorted set 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.

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

where F: FnMut(&'a T) -> B, B: Ord,

Search over a sorted set 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.

pub fn partition_point<P>(&self, pred: P) -> usize

where P: FnMut(&T) -> bool,

Returns the index of the partition point of a sorted set according to the given predicate (the index of the first element of the second partition).

See slice::partition_point for more details.

Computes in O(log(n)) time.

Trait Implementations

impl Clone for Box<Slice>

fn clone(&self) -> Box<Slice>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for Slice<V>

where V: Debug,

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

Formats the value using the given formatter.

impl Default for &Slice

fn default() -> &Slice

Returns the “default value” for a type.

impl Default for Box<Slice>

fn default() -> Box<Slice>

Returns the “default value” for a type.

impl Deref for Slice

type Target = Slice<Entity>

The resulting type after dereferencing.

fn deref(&self) -> &<Slice as Deref>::Target

Dereferences the value.

impl From<&Slice> for Box<Slice>

fn from(value: &Slice) -> Box<Slice>

Converts to this type from the input type.

impl Hash for Slice

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

where H: Hasher,

Feeds this value into the given Hasher.

impl Index<(Bound<usize>, Bound<usize>)> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: (Bound<usize>, Bound<usize>)) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: Range<usize>) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: RangeFrom<usize>) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: RangeFull) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: RangeInclusive<usize>) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: RangeTo<usize>) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for Slice

type Output = Slice

The returned type after indexing.

fn index(&self, key: RangeToInclusive<usize>) -> &Slice

Performs the indexing (container[index]) operation.

impl Index<usize> for Slice

type Output = Entity

The returned type after indexing.

fn index(&self, key: usize) -> &Entity

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Slice

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

type Item = &'a Entity

The type of the elements being iterated over.

fn into_iter(self) -> <&'a Slice as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for Box<Slice>

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

type Item = Entity

The type of the elements being iterated over.

fn into_iter(self) -> <Box<Slice> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Ord for Slice

fn cmp(&self, other: &Slice) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for Slice

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

fn partial_cmp(&self, other: &Slice) -> 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 Eq for Slice