Struct indexmap::map::slice::Slice

source ·

#[repr(transparent)]pub struct Slice<K, V> {
    pub(crate) entries: [Bucket<K, V>],
}

Expand description

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

This supports indexed operations much like a [(K, V)] slice, but not any hashed operations on the map keys.

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

Fields§

§entries: [Bucket<K, V>]

Implementations§

source §

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

Returns an empty slice.

source

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

Returns an empty mutable slice.

source

pub const fn len(&self) -> usize

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

source

pub const 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_index_mut(&mut self, index: usize) -> Option<(&K, &mut V)>

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

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

source

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

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

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

source

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

Returns a mutable 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 first_mut(&mut self) -> Option<(&K, &mut V)>

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

source

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

Get the last key-value pair.

source

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

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

source

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

Divides one slice into two at an index.

Panics if index > len.

source

pub fn split_at_mut(&mut self, index: usize) -> (&mut Self, &mut Self)

Divides one mutable slice into two at an index.

Panics if index > len.

source

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

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

source

pub fn split_first_mut(&mut self) -> Option<((&K, &mut V), &mut Self)>

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

source

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

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

source

pub fn split_last_mut(&mut self) -> Option<((&K, &mut V), &mut Self)>

Returns the last key-value pair and the rest of the slice, with mutable access to the value, 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 iter_mut(&mut self) -> IterMut<'_, 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 into_keys(self: Box<Self>) -> IntoKeys<K, V> ⓘ

Return an owning 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 values_mut(&mut self) -> ValuesMut<'_, K, V> ⓘ

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

source

pub fn into_values(self: Box<Self>) -> IntoValues<K, V> ⓘ

Return an owning 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