Struct EntityIndexSet 

pub struct EntityIndexSet(/* private fields */);

An [IndexSet] pre-configured to use EntityHash hashing.

Implementations

impl EntityIndexSet

pub const fn new() -> EntityIndexSet

Creates an empty EntityIndexSet.

Equivalent to IndexSet::with_hasher(EntityHash).

pub fn with_capacity(n: usize) -> EntityIndexSet

Creates an empty EntityIndexSet with the specified capacity.

Equivalent to IndexSet::with_capacity_and_hasher(n, EntityHash).

pub const fn from_index_set(set: IndexSet<Entity, EntityHash>) -> EntityIndexSet

Constructs an EntityIndexSet from an [IndexSet].

pub fn into_inner(self) -> IndexSet<Entity, EntityHash>

Returns the inner [IndexSet].

pub fn as_slice(&self) -> &Slice

Returns a slice of all the values in the set.

Equivalent to [IndexSet::as_slice].

pub fn drain<R>(&mut self, range: R) -> Drain<'_>

where R: RangeBounds<usize>,

Clears the IndexSet in the given index range, returning those values as a drain iterator.

Equivalent to [IndexSet::drain].

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 [IndexSet::get_range].

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

Return an iterator over the values of the set, in their order.

Equivalent to [IndexSet::iter].

pub fn into_boxed_slice(self) -> Box<Slice>

Converts into a boxed slice of all the values in the set.

Equivalent to [IndexSet::into_boxed_slice].

Methods from Deref<Target = IndexSet<Entity, EntityHash>>

pub fn capacity(&self) -> usize

Return the number of elements the set can hold without reallocating.

This number is a lower bound; the set might be able to hold more, but is guaranteed to be able to hold at least this many.

Computes in O(1) time.

pub fn hasher(&self) -> &S

Return a reference to the set’s BuildHasher.

pub fn len(&self) -> usize

Return the number of elements in the set.

Computes in O(1) time.

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

Computes in O(1) time.

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

Return an iterator over the values of the set, in their order

pub fn clear(&mut self)

Remove all elements in the set, while preserving its capacity.

Computes in O(n) time.

pub fn truncate(&mut self, len: usize)

Shortens the set, keeping the first len elements and dropping the rest.

If len is greater than the set’s current length, this has no effect.

pub fn drain<R>(&mut self, range: R) -> Drain<'_, T>

where R: RangeBounds<usize>,

Clears the IndexSet in the given index range, returning those values as a drain iterator.

The range may be any type that implements RangeBounds<usize>, including all of the std::ops::Range* types, or even a tuple pair of Bound start and end values. To drain the set entirely, use RangeFull like set.drain(..).

This shifts down all entries following the drained range to fill the gap, and keeps the allocated memory for reuse.

Panics if the starting point is greater than the end point or if the end point is greater than the length of the set.

pub fn extract_if<F, R>(&mut self, range: R, pred: F) -> ExtractIf<'_, T, F>

where F: FnMut(&T) -> bool, R: RangeBounds<usize>,

Creates an iterator which uses a closure to determine if a value should be removed, for all values in the given range.

If the closure returns true, then the value is removed and yielded. If the closure returns false, the value will remain in the list and will not be yielded by the iterator.

The range may be any type that implements RangeBounds<usize>, including all of the std::ops::Range* types, or even a tuple pair of Bound start and end values. To check the entire set, use RangeFull like set.extract_if(.., predicate).

If the returned ExtractIf is not exhausted, e.g. because it is dropped without iterating or the iteration short-circuits, then the remaining elements will be retained. Use retain with a negated predicate if you do not need the returned iterator.

Panics if the starting point is greater than the end point or if the end point is greater than the length of the set.

Examples

Splitting a set into even and odd values, reusing the original set:

use indexmap::IndexSet;

let mut set: IndexSet<i32> = (0..8).collect();
let extracted: IndexSet<i32> = set.extract_if(.., |v| v % 2 == 0).collect();

let evens = extracted.into_iter().collect::<Vec<_>>();
let odds = set.into_iter().collect::<Vec<_>>();

assert_eq!(evens, vec![0, 2, 4, 6]);
assert_eq!(odds, vec![1, 3, 5, 7]);

pub fn split_off(&mut self, at: usize) -> IndexSet<T, S>

where S: Clone,

Splits the collection into two at the given index.

Returns a newly allocated set containing the elements in the range [at, len). After the call, the original set will be left containing the elements [0, at) with its previous capacity unchanged.

Panics if at > len.

pub fn reserve(&mut self, additional: usize)

Reserve capacity for additional more values.

Computes in O(n) time.

pub fn reserve_exact(&mut self, additional: usize)

Reserve capacity for additional more values, without over-allocating.

Unlike reserve, this does not deliberately over-allocate the entry capacity to avoid frequent re-allocations. However, the underlying data structures may still have internal capacity requirements, and the allocator itself may give more space than requested, so this cannot be relied upon to be precisely minimal.

Computes in O(n) time.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Try to reserve capacity for additional more values.

Computes in O(n) time.

pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

Try to reserve capacity for additional more values, without over-allocating.

Unlike try_reserve, this does not deliberately over-allocate the entry capacity to avoid frequent re-allocations. However, the underlying data structures may still have internal capacity requirements, and the allocator itself may give more space than requested, so this cannot be relied upon to be precisely minimal.

Computes in O(n) time.

pub fn shrink_to_fit(&mut self)

Shrink the capacity of the set as much as possible.

Computes in O(n) time.

pub fn shrink_to(&mut self, min_capacity: usize)

Shrink the capacity of the set with a lower limit.

Computes in O(n) time.

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

Insert the value into the set.

If an equivalent item already exists in the set, it returns false leaving the original value in the set and without altering its insertion order. Otherwise, it inserts the new item and returns true.

Computes in O(1) time (amortized average).

pub fn insert_full(&mut self, value: T) -> (usize, bool)

Insert the value into the set, and get its index.

If an equivalent item already exists in the set, it returns the index of the existing item and false, leaving the original value in the set and without altering its insertion order. Otherwise, it inserts the new item and returns the index of the inserted item and true.

Computes in O(1) time (amortized average).

pub fn insert_sorted(&mut self, value: T) -> (usize, bool)

where T: Ord,

Insert the value into the set at its ordered position among sorted values.

This is equivalent to finding the position with [binary_search][Self::binary_search], and if needed calling [insert_before][Self::insert_before] for a new value.

If the sorted item is found in the set, it returns the index of that existing item and false, without any change. Otherwise, it inserts the new item and returns its sorted index and true.

If the existing items are not already sorted, then the insertion index is unspecified (like slice::binary_search), but the value is moved to or inserted at that position regardless.

Computes in O(n) time (average). Instead of repeating calls to insert_sorted, it may be faster to call batched [insert][Self::insert] or [extend][Self::extend] and only call [sort][Self::sort] or [sort_unstable][Self::sort_unstable] once.

pub fn insert_sorted_by<F>(&mut self, value: T, cmp: F) -> (usize, bool)

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

Insert the value into the set at its ordered position among values sorted by cmp.

This is equivalent to finding the position with [binary_search_by][Self::binary_search_by], then calling [insert_before][Self::insert_before].

If the existing items are not already sorted, then the insertion index is unspecified (like slice::binary_search), but the value is moved to or inserted at that position regardless.

Computes in O(n) time (average).

pub fn insert_sorted_by_key<B, F>( &mut self, value: T, sort_key: F, ) -> (usize, bool)

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

Insert the value into the set at its ordered position among values using a sort-key extraction function.

This is equivalent to finding the position with [binary_search_by_key][Self::binary_search_by_key] with sort_key(key), then calling [insert_before][Self::insert_before].

If the existing items are not already sorted, then the insertion index is unspecified (like slice::binary_search), but the value is moved to or inserted at that position regardless.

Computes in O(n) time (average).

pub fn insert_before(&mut self, index: usize, value: T) -> (usize, bool)

Insert the value into the set before the value at the given index, or at the end.

If an equivalent item already exists in the set, it returns false leaving the original value in the set, but moved to the new position. The returned index will either be the given index or one less, depending on how the value moved. (See shift_insert for different behavior here.)

Otherwise, it inserts the new value exactly at the given index and returns true.

Panics if index is out of bounds. Valid indices are 0..=set.len() (inclusive).

Computes in O(n) time (average).

Examples

use indexmap::IndexSet;
let mut set: IndexSet<char> = ('a'..='z').collect();

// The new value '*' goes exactly at the given index.
assert_eq!(set.get_index_of(&'*'), None);
assert_eq!(set.insert_before(10, '*'), (10, true));
assert_eq!(set.get_index_of(&'*'), Some(10));

// Moving the value 'a' up will shift others down, so this moves *before* 10 to index 9.
assert_eq!(set.insert_before(10, 'a'), (9, false));
assert_eq!(set.get_index_of(&'a'), Some(9));
assert_eq!(set.get_index_of(&'*'), Some(10));

// Moving the value 'z' down will shift others up, so this moves to exactly 10.
assert_eq!(set.insert_before(10, 'z'), (10, false));
assert_eq!(set.get_index_of(&'z'), Some(10));
assert_eq!(set.get_index_of(&'*'), Some(11));

// Moving or inserting before the endpoint is also valid.
assert_eq!(set.len(), 27);
assert_eq!(set.insert_before(set.len(), '*'), (26, false));
assert_eq!(set.get_index_of(&'*'), Some(26));
assert_eq!(set.insert_before(set.len(), '+'), (27, true));
assert_eq!(set.get_index_of(&'+'), Some(27));
assert_eq!(set.len(), 28);

pub fn shift_insert(&mut self, index: usize, value: T) -> bool

Insert the value into the set at the given index.

If an equivalent item already exists in the set, it returns false leaving the original value in the set, but moved to the given index. Note that existing values cannot be moved to index == set.len()! (See insert_before for different behavior here.)

Otherwise, it inserts the new value at the given index and returns true.

Panics if index is out of bounds. Valid indices are 0..set.len() (exclusive) when moving an existing value, or 0..=set.len() (inclusive) when inserting a new value.

Computes in O(n) time (average).

Examples

use indexmap::IndexSet;
let mut set: IndexSet<char> = ('a'..='z').collect();

// The new value '*' goes exactly at the given index.
assert_eq!(set.get_index_of(&'*'), None);
assert_eq!(set.shift_insert(10, '*'), true);
assert_eq!(set.get_index_of(&'*'), Some(10));

// Moving the value 'a' up to 10 will shift others down, including the '*' that was at 10.
assert_eq!(set.shift_insert(10, 'a'), false);
assert_eq!(set.get_index_of(&'a'), Some(10));
assert_eq!(set.get_index_of(&'*'), Some(9));

// Moving the value 'z' down to 9 will shift others up, including the '*' that was at 9.
assert_eq!(set.shift_insert(9, 'z'), false);
assert_eq!(set.get_index_of(&'z'), Some(9));
assert_eq!(set.get_index_of(&'*'), Some(10));

// Existing values can move to len-1 at most, but new values can insert at the endpoint.
assert_eq!(set.len(), 27);
assert_eq!(set.shift_insert(set.len() - 1, '*'), false);
assert_eq!(set.get_index_of(&'*'), Some(26));
assert_eq!(set.shift_insert(set.len(), '+'), true);
assert_eq!(set.get_index_of(&'+'), Some(27));
assert_eq!(set.len(), 28);

use indexmap::IndexSet;
let mut set: IndexSet<char> = ('a'..='z').collect();

// This is an invalid index for moving an existing value!
set.shift_insert(set.len(), 'a');

pub fn replace(&mut self, value: T) -> Option<T>

Adds a value to the set, replacing the existing value, if any, that is equal to the given one, without altering its insertion order. Returns the replaced value.

Computes in O(1) time (average).

pub fn replace_full(&mut self, value: T) -> (usize, Option<T>)

Adds a value to the set, replacing the existing value, if any, that is equal to the given one, without altering its insertion order. Returns the index of the item and its replaced value.

Computes in O(1) time (average).

pub fn replace_index(&mut self, index: usize, value: T) -> Result<T, (usize, T)>

Replaces the value at the given index. The new value does not need to be equivalent to the one it is replacing, but it must be unique to the rest of the set.

Returns Ok(old_value) if successful, or Err((other_index, value)) if an equivalent value already exists at a different index. The set will be unchanged in the error case.

Panics if index is out of bounds.

Computes in O(1) time (average).

pub fn difference<'a, S2>( &'a self, other: &'a IndexSet<T, S2>, ) -> Difference<'a, T, S2>

where S2: BuildHasher,

Return an iterator over the values that are in self but not other.

Values are produced in the same order that they appear in self.

pub fn symmetric_difference<'a, S2>( &'a self, other: &'a IndexSet<T, S2>, ) -> SymmetricDifference<'a, T, S, S2>

where S2: BuildHasher,

Return an iterator over the values that are in self or other, but not in both.

Values from self are produced in their original order, followed by values from other in their original order.

pub fn intersection<'a, S2>( &'a self, other: &'a IndexSet<T, S2>, ) -> Intersection<'a, T, S2>

where S2: BuildHasher,

Return an iterator over the values that are in both self and other.

Values are produced in the same order that they appear in self.

pub fn union<'a, S2>(&'a self, other: &'a IndexSet<T, S2>) -> Union<'a, T, S>

where S2: BuildHasher,

Return an iterator over all values that are in self or other.

Values from self are produced in their original order, followed by values that are unique to other in their original order.

pub fn splice<R, I>( &mut self, range: R, replace_with: I, ) -> Splice<'_, <I as IntoIterator>::IntoIter, T, S>

where R: RangeBounds<usize>, I: IntoIterator<Item = T>,

Creates a splicing iterator that replaces the specified range in the set with the given replace_with iterator and yields the removed items. replace_with does not need to be the same length as range.

The range is removed even if the iterator is not consumed until the end. It is unspecified how many elements are removed from the set if the Splice value is leaked.

The input iterator replace_with is only consumed when the Splice value is dropped. If a value from the iterator matches an existing entry in the set (outside of range), then the original will be unchanged. Otherwise, the new value will be inserted in the replaced range.

Panics if the starting point is greater than the end point or if the end point is greater than the length of the set.

Examples

use indexmap::IndexSet;

let mut set = IndexSet::from([0, 1, 2, 3, 4]);
let new = [5, 4, 3, 2, 1];
let removed: Vec<_> = set.splice(2..4, new).collect();

// 1 and 4 kept their positions, while 5, 3, and 2 were newly inserted.
assert!(set.into_iter().eq([0, 1, 5, 3, 2, 4]));
assert_eq!(removed, &[2, 3]);

pub fn append<S2>(&mut self, other: &mut IndexSet<T, S2>)

Moves all values from other into self, leaving other empty.

This is equivalent to calling [insert][Self::insert] for each value from other in order, which means that values that already exist in self are unchanged in their current position.

See also [union][Self::union] to iterate the combined values by reference, without modifying self or other.

Examples

use indexmap::IndexSet;

let mut a = IndexSet::from([3, 2, 1]);
let mut b = IndexSet::from([3, 4, 5]);
let old_capacity = b.capacity();

a.append(&mut b);

assert_eq!(a.len(), 5);
assert_eq!(b.len(), 0);
assert_eq!(b.capacity(), old_capacity);

assert!(a.iter().eq(&[3, 2, 1, 4, 5]));

pub fn contains<Q>(&self, value: &Q) -> bool

where Q: Hash + Equivalent<T> + ?Sized,

Return true if an equivalent to value exists in the set.

Computes in O(1) time (average).

pub fn get<Q>(&self, value: &Q) -> Option<&T>

where Q: Hash + Equivalent<T> + ?Sized,

Return a reference to the value stored in the set, if it is present, else None.

Computes in O(1) time (average).

pub fn get_full<Q>(&self, value: &Q) -> Option<(usize, &T)>

where Q: Hash + Equivalent<T> + ?Sized,

Return item index and value

pub fn get_index_of<Q>(&self, value: &Q) -> Option<usize>

where Q: Hash + Equivalent<T> + ?Sized,

Return item index, if it exists in the set

Computes in O(1) time (average).

pub fn remove<Q>(&mut self, value: &Q) -> bool

where Q: Hash + Equivalent<T> + ?Sized,

👎Deprecated:

remove disrupts the set order – use swap_remove or shift_remove for explicit behavior.

Remove the value from the set, and return true if it was present.

NOTE: This is equivalent to [.swap_remove(value)][Self::swap_remove], replacing this value’s position with the last element, and it is deprecated in favor of calling that explicitly. If you need to preserve the relative order of the values in the set, use [.shift_remove(value)][Self::shift_remove] instead.

pub fn swap_remove<Q>(&mut self, value: &Q) -> bool

where Q: Hash + Equivalent<T> + ?Sized,

Remove the value from the set, and return true if it was present.

Like Vec::swap_remove, the value is removed by swapping it with the last element of the set and popping it off. This perturbs the position of what used to be the last element!

Return false if value was not in the set.

Computes in O(1) time (average).

pub fn shift_remove<Q>(&mut self, value: &Q) -> bool

where Q: Hash + Equivalent<T> + ?Sized,

Remove the value from the set, and return true if it was present.

Like Vec::remove, the value is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return false if value was not in the set.

Computes in O(n) time (average).

pub fn take<Q>(&mut self, value: &Q) -> Option<T>

where Q: Hash + Equivalent<T> + ?Sized,

👎Deprecated:

take disrupts the set order – use swap_take or shift_take for explicit behavior.

Removes and returns the value in the set, if any, that is equal to the given one.

NOTE: This is equivalent to [.swap_take(value)][Self::swap_take], replacing this value’s position with the last element, and it is deprecated in favor of calling that explicitly. If you need to preserve the relative order of the values in the set, use [.shift_take(value)][Self::shift_take] instead.

pub fn swap_take<Q>(&mut self, value: &Q) -> Option<T>

where Q: Hash + Equivalent<T> + ?Sized,

Removes and returns the value in the set, if any, that is equal to the given one.

Like Vec::swap_remove, the value is removed by swapping it with the last element of the set and popping it off. This perturbs the position of what used to be the last element!

Return None if value was not in the set.

Computes in O(1) time (average).

pub fn shift_take<Q>(&mut self, value: &Q) -> Option<T>

where Q: Hash + Equivalent<T> + ?Sized,

Removes and returns the value in the set, if any, that is equal to the given one.

Like Vec::remove, the value is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if value was not in the set.

Computes in O(n) time (average).

pub fn swap_remove_full<Q>(&mut self, value: &Q) -> Option<(usize, T)>

where Q: Hash + Equivalent<T> + ?Sized,

Remove the value from the set return it and the index it had.

Like Vec::swap_remove, the value is removed by swapping it with the last element of the set and popping it off. This perturbs the position of what used to be the last element!

Return None if value was not in the set.

pub fn shift_remove_full<Q>(&mut self, value: &Q) -> Option<(usize, T)>

where Q: Hash + Equivalent<T> + ?Sized,

Remove the value from the set return it and the index it had.

Like Vec::remove, the value is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if value was not in the set.

pub fn pop(&mut self) -> Option<T>

Remove the last value

This preserves the order of the remaining elements.

Computes in O(1) time (average).

pub fn pop_if(&mut self, predicate: impl FnOnce(&T) -> bool) -> Option<T>

Removes and returns the last value from a set if the predicate returns true, or None if the predicate returns false or the set is empty (the predicate will not be called in that case).

This preserves the order of the remaining elements.

Computes in O(1) time (average).

Examples

use indexmap::IndexSet;

let mut set = IndexSet::from([1, 2, 3, 4]);
let pred = |x: &i32| *x % 2 == 0;

assert_eq!(set.pop_if(pred), Some(4));
assert_eq!(set.as_slice(), &[1, 2, 3]);
assert_eq!(set.pop_if(pred), None);

pub fn retain<F>(&mut self, keep: F)

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

Scan through each value in the set and keep those where the closure keep returns true.

The elements are visited in order, and remaining elements keep their order.

Computes in O(n) time (average).

pub fn sort(&mut self)

where T: Ord,

Sort the set’s values by their default ordering.

This is a stable sort – but equivalent values should not normally coexist in a set at all, so [sort_unstable][Self::sort_unstable] is preferred because it is generally faster and doesn’t allocate auxiliary memory.

See sort_by for details.

pub fn sort_by<F>(&mut self, cmp: F)

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

Sort the set’s values in place using the comparison function cmp.

Computes in O(n log n) time and O(n) space. The sort is stable.

pub fn sort_by_key<K, F>(&mut self, sort_key: F)

where K: Ord, F: FnMut(&T) -> K,

Sort the set’s values in place using a key extraction function.

Computes in O(n log n) time and O(n) space. The sort is stable.

pub fn sort_unstable(&mut self)

where T: Ord,

Sort the set’s values by their default ordering.

See sort_unstable_by for details.

pub fn sort_unstable_by<F>(&mut self, cmp: F)

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

Sort the set’s values in place using the comparison function cmp.

Computes in O(n log n) time. The sort is unstable.

pub fn sort_unstable_by_key<K, F>(&mut self, sort_key: F)

where K: Ord, F: FnMut(&T) -> K,

Sort the set’s values in place using a key extraction function.

Computes in O(n log n) time. The sort is unstable.

pub fn sort_by_cached_key<K, F>(&mut self, sort_key: F)

where K: Ord, F: FnMut(&T) -> K,

Sort the set’s values in place using a key extraction function.

During sorting, the function is called at most once per entry, by using temporary storage to remember the results of its evaluation. The order of calls to the function is unspecified and may change between versions of indexmap or the standard library.

Computes in O(m n + n log n + c) time () and O(n) space, where the function is O(m), n is the length of the map, and c the capacity. The sort is stable.

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 using [get_index_of][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 is_sorted(&self) -> bool

where T: PartialOrd,

Checks if the values of this set are sorted.

pub fn is_sorted_by<'a, F>(&'a self, cmp: F) -> bool

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

Checks if this set is sorted using the given comparator function.

pub fn is_sorted_by_key<'a, F, K>(&'a self, sort_key: F) -> bool

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

Checks if this set is sorted using the given sort-key function.

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.

pub fn reverse(&mut self)

Reverses the order of the set’s values in place.

Computes in O(n) time and O(1) space.

pub fn as_slice(&self) -> &Slice<T>

Returns a slice of all the values in the set.

Computes in O(1) time.

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

Get a value by index

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

Computes in O(1) time.

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().

Computes in O(1) time.

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

Get the first value

Computes in O(1) time.

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

Get the last value

Computes in O(1) time.

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

Remove the value by index

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

Like Vec::swap_remove, the value is removed by swapping it with the last element of the set and popping it off. This perturbs the position of what used to be the last element!

Computes in O(1) time (average).

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

Remove the value by index

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

Like Vec::remove, the value is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Computes in O(n) time (average).

pub fn move_index(&mut self, from: usize, to: usize)

Moves the position of a value from one index to another by shifting all other values in-between.

• If from < to, the other values will shift down while the targeted value moves up.
• If from > to, the other values will shift up while the targeted value moves down.

Panics if from or to are out of bounds.

Computes in O(n) time (average).

pub fn swap_indices(&mut self, a: usize, b: usize)

Swaps the position of two values in the set.

Panics if a or b are out of bounds.

Computes in O(1) time (average).

pub fn is_disjoint<S2>(&self, other: &IndexSet<T, S2>) -> bool

where S2: BuildHasher,

Returns true if self has no elements in common with other.

pub fn is_subset<S2>(&self, other: &IndexSet<T, S2>) -> bool

where S2: BuildHasher,

Returns true if all elements of self are contained in other.

pub fn is_superset<S2>(&self, other: &IndexSet<T, S2>) -> bool

where S2: BuildHasher,

Returns true if all elements of other are contained in self.

Trait Implementations

impl BitAnd for &EntityIndexSet

type Output = EntityIndexSet

The resulting type after applying the & operator.

fn bitand(self, rhs: &EntityIndexSet) -> <&EntityIndexSet as BitAnd>::Output

Performs the & operation.

impl BitOr for &EntityIndexSet

type Output = EntityIndexSet

The resulting type after applying the | operator.

fn bitor(self, rhs: &EntityIndexSet) -> <&EntityIndexSet as BitOr>::Output

Performs the | operation.

impl BitXor for &EntityIndexSet

type Output = EntityIndexSet

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &EntityIndexSet) -> <&EntityIndexSet as BitXor>::Output

Performs the ^ operation.

impl Clone for EntityIndexSet

fn clone(&self) -> EntityIndexSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityIndexSet

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

Formats the value using the given formatter.

impl Default for EntityIndexSet

fn default() -> EntityIndexSet

Returns the “default value” for a type.

impl Deref for EntityIndexSet

type Target = IndexSet<Entity, EntityHash>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for EntityIndexSet

fn deref_mut(&mut self) -> &mut <EntityIndexSet as Deref>::Target

Mutably dereferences the value.

impl<'a> Extend<&'a Entity> for EntityIndexSet

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = &'a Entity>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Entity> for EntityIndexSet

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Entity>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<const N: usize> From<[Entity; N]> for EntityIndexSet

fn from(value: [Entity; N]) -> EntityIndexSet

Converts to this type from the input type.

impl FromIterator<Entity> for EntityIndexSet

fn from_iter<I>(iterable: I) -> EntityIndexSet

where I: IntoIterator<Item = Entity>,

Creates a value from an iterator.

impl FromReflect for EntityIndexSet

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<EntityIndexSet>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for EntityIndexSet

fn get_type_registration() -> TypeRegistration

Returns the default [TypeRegistration] for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

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

type Output = Slice

The returned type after indexing.

fn index( &self, key: (Bound<usize>, Bound<usize>), ) -> &<EntityIndexSet as Index<(Bound<usize>, Bound<usize>)>>::Output

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for EntityIndexSet

type Output = Slice

The returned type after indexing.

fn index( &self, key: Range<usize>, ) -> &<EntityIndexSet as Index<Range<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for EntityIndexSet

type Output = Slice

The returned type after indexing.

fn index( &self, key: RangeFrom<usize>, ) -> &<EntityIndexSet as Index<RangeFrom<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for EntityIndexSet

type Output = Slice

The returned type after indexing.

fn index(&self, key: RangeFull) -> &<EntityIndexSet as Index<RangeFull>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for EntityIndexSet

type Output = Slice

The returned type after indexing.

fn index( &self, key: RangeInclusive<usize>, ) -> &<EntityIndexSet as Index<RangeInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for EntityIndexSet

type Output = Slice

The returned type after indexing.

fn index( &self, key: RangeTo<usize>, ) -> &<EntityIndexSet as Index<RangeTo<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for EntityIndexSet

type Output = Slice

The returned type after indexing.

fn index( &self, key: RangeToInclusive<usize>, ) -> &<EntityIndexSet as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for EntityIndexSet

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 EntityIndexSet

type Item = &'a Entity

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl IntoIterator for EntityIndexSet

type Item = Entity

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl MapEntities for EntityIndexSet

fn map_entities<E>(&mut self, entity_mapper: &mut E)

where E: EntityMapper,

Updates all Entity references stored inside using entity_mapper.

impl<S2> PartialEq<IndexSet<Entity, S2>> for EntityIndexSet

where S2: BuildHasher,

fn eq(&self, other: &IndexSet<Entity, S2>) -> 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 PartialEq for EntityIndexSet

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

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<EntityIndexSet>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<EntityIndexSet>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<EntityIndexSet>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing [PartialReflect], combines reflect_clone and take in a useful fashion, automatically constructing an appropriate [ReflectCloneError] if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for EntityIndexSet

fn into_any(self: Box<EntityIndexSet>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<EntityIndexSet>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl RelationshipSourceCollection for EntityIndexSet

type SourceIter<'a> = Copied<Iter<'a>>

The type of iterator returned by the iter method.

fn new() -> EntityIndexSet

Creates a new empty instance.

fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more entities to be inserted.

fn with_capacity(capacity: usize) -> EntityIndexSet

Returns an instance with the given pre-allocated entity capacity.

fn add(&mut self, entity: Entity) -> bool

Adds the given entity to the collection.

fn remove(&mut self, entity: Entity) -> bool

Removes the given entity from the collection.

fn iter( &self, ) -> <EntityIndexSet as RelationshipSourceCollection>::SourceIter<'_>

Iterates all entities in the collection.

fn len(&self) -> usize

Returns the current length of the collection.

fn clear(&mut self)

Clears the collection.

fn shrink_to_fit(&mut self)

Attempts to save memory by shrinking the capacity to fit the current length.

fn extend_from_iter(&mut self, entities: impl IntoIterator<Item = Entity>)

Add multiple entities to collection at once.

fn is_empty(&self) -> bool

Returns true if the collection contains no entities.

fn source_to_remove_before_add(&self) -> Option<Entity>

For one-to-one relationships, returns the entity that should be removed before adding a new one. Returns None for one-to-many relationships or when no entity needs to be removed.

impl Sub for &EntityIndexSet

type Output = EntityIndexSet

The resulting type after applying the - operator.

fn sub(self, rhs: &EntityIndexSet) -> <&EntityIndexSet as Sub>::Output

Performs the - operation.

impl TupleStruct for EntityIndexSet

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new [DynamicTupleStruct] from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if [TypeInfo] is not available.

impl TypePath for EntityIndexSet

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for EntityIndexSet

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for EntityIndexSet