Struct indexmap::set::Slice

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

A dynamically-sized slice of values in an IndexSet.

This supports indexed operations much like a [T] slice, but not any hashed operations on the values.

Unlike IndexSet, Slice does consider the order for PartialEq and Eq, and it also implements PartialOrd, Ord, and Hash.

Implementations

impl<T> Slice<T>

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

Returns an empty slice.

pub const fn len(&self) -> usize

Return the number of elements in the set slice.

pub const 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: RangeBounds<usize>>(&self, range: R) -> Option<&Self>

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) -> (&Self, &Self)

Divides one slice into two at an index.

Panics if index > len.

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

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

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

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<T: Clone> Clone for Box<Slice<T>>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Slice<T>

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

Formats the value using the given formatter.

impl<T> Default for &Slice<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Default for Box<Slice<T>>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy> From<&Slice<T>> for Box<Slice<T>>

fn from(slice: &Slice<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Slice<T>

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

Feeds this value into the given Hasher.

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

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: (Bound<usize>, Bound<usize>)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<Range<usize>> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFrom<usize>> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFull> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeInclusive<usize>> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeTo<usize>> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeToInclusive<usize>> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index(&self, range: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for Slice<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a Slice<T>

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

type Item = &'a T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Box<Slice<T>>

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for Slice<T>

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

This method returns an Ordering between self and other.

impl<T: PartialEq> PartialEq for Slice<T>

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

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