pub trait Index<Idx> where
Idx: ?Sized, {
type Output: ?Sized;
fn index(&self, index: Idx) -> &Self::Output;
}
Expand description
Used for indexing operations (container[index]
) in immutable contexts.
container[index]
is actually syntactic sugar for *container.index(index)
,
but only when used as an immutable value. If a mutable value is requested,
IndexMut
is used instead. This allows nice things such as
let value = v[index]
if the type of value
implements Copy
.
Examples
The following example implements Index
on a read-only NucleotideCount
container, enabling individual counts to be retrieved with index syntax.
use std::ops::Index;
enum Nucleotide {
A,
C,
G,
T,
}
struct NucleotideCount {
a: usize,
c: usize,
g: usize,
t: usize,
}
impl Index<Nucleotide> for NucleotideCount {
type Output = usize;
fn index(&self, nucleotide: Nucleotide) -> &Self::Output {
match nucleotide {
Nucleotide::A => &self.a,
Nucleotide::C => &self.c,
Nucleotide::G => &self.g,
Nucleotide::T => &self.t,
}
}
}
let nucleotide_count = NucleotideCount {a: 14, c: 9, g: 10, t: 12};
assert_eq!(nucleotide_count[Nucleotide::A], 14);
assert_eq!(nucleotide_count[Nucleotide::C], 9);
assert_eq!(nucleotide_count[Nucleotide::G], 10);
assert_eq!(nucleotide_count[Nucleotide::T], 12);
Associated Types
Required methods
Implementations on Foreign Types
sourceimpl<'_, K, Q, V, S> Index<&'_ Q> for HashMap<K, V, S> where
K: Eq + Hash + Borrow<Q>,
Q: Eq + Hash + ?Sized,
S: BuildHasher,
impl<'_, K, Q, V, S> Index<&'_ Q> for HashMap<K, V, S> where
K: Eq + Hash + Borrow<Q>,
Q: Eq + Hash + ?Sized,
S: BuildHasher,
1.50.0 (const: unstable) · sourceimpl<T, I, const N: usize> Index<I> for [T; N] where
[T]: Index<I>,
impl<T, I, const N: usize> Index<I> for [T; N] where
[T]: Index<I>,
const: unstable · sourceimpl<I> Index<I> for str where
I: SliceIndex<str>,
impl<I> Index<I> for str where
I: SliceIndex<str>,
type Output = <I as SliceIndex<str>>::Output
fn index(&self, index: I) -> &<I as SliceIndex<str>>::Output
1.26.0 · sourceimpl Index<RangeToInclusive<usize>> for String
impl Index<RangeToInclusive<usize>> for String
1.26.0 · sourceimpl Index<RangeInclusive<usize>> for String
impl Index<RangeInclusive<usize>> for String
sourceimpl<K, V, S> Index<usize> for IndexMap<K, V, S>
impl<K, V, S> Index<usize> for IndexMap<K, V, S>
Access IndexMap
values at indexed positions.
Examples
use indexmap::IndexMap;
let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map[0], "LOREM");
assert_eq!(map[1], "IPSUM");
map.reverse();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "SIT");
map.sort_keys();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "DOLOR");
use indexmap::IndexMap;
let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map[10]); // panics!
sourceimpl<T, S> Index<usize> for IndexSet<T, S>
impl<T, S> Index<usize> for IndexSet<T, S>
Access IndexSet
values at indexed positions.
Examples
use indexmap::IndexSet;
let mut set = IndexSet::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
set.insert(word.to_string());
}
assert_eq!(set[0], "Lorem");
assert_eq!(set[1], "ipsum");
set.reverse();
assert_eq!(set[0], "amet");
assert_eq!(set[1], "sit");
set.sort();
assert_eq!(set[0], "Lorem");
assert_eq!(set[1], "amet");
use indexmap::IndexSet;
let mut set = IndexSet::new();
set.insert("foo");
println!("{:?}", set[10]); // panics!
sourceimpl<'_, K, V, Q, S> Index<&'_ Q> for IndexMap<K, V, S> where
Q: Hash + Equivalent<K> + ?Sized,
K: Hash + Eq,
S: BuildHasher,
impl<'_, K, V, Q, S> Index<&'_ Q> for IndexMap<K, V, S> where
Q: Hash + Equivalent<K> + ?Sized,
K: Hash + Eq,
S: BuildHasher,
Access IndexMap
values corresponding to a key.
Examples
use indexmap::IndexMap;
let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map["lorem"], "LOREM");
assert_eq!(map["ipsum"], "IPSUM");
use indexmap::IndexMap;
let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map["bar"]); // panics!
sourceimpl<'_, K, Q, V, S, A> Index<&'_ Q> for HashMap<K, V, S, A> where
K: Eq + Hash + Borrow<Q>,
Q: Eq + Hash + ?Sized,
S: BuildHasher,
A: Allocator + Clone,
impl<'_, K, Q, V, S, A> Index<&'_ Q> for HashMap<K, V, S, A> where
K: Eq + Hash + Borrow<Q>,
Q: Eq + Hash + ?Sized,
S: BuildHasher,
A: Allocator + Clone,
sourceimpl<'input, Endian> Index<usize> for EndianSlice<'input, Endian> where
Endian: Endianity,
impl<'input, Endian> Index<usize> for EndianSlice<'input, Endian> where
Endian: Endianity,
sourceimpl<'input, Endian> Index<RangeFrom<usize>> for EndianSlice<'input, Endian> where
Endian: Endianity,
impl<'input, Endian> Index<RangeFrom<usize>> for EndianSlice<'input, Endian> where
Endian: Endianity,
Implementors
sourceimpl Index<SignatureIndex> for ModuleTypes
impl Index<SignatureIndex> for ModuleTypes
type Output = WasmFuncType
sourceimpl<I, T, const LANES: usize> Index<I> for Simd<T, LANES> where
T: SimdElement,
I: SliceIndex<[T]>,
LaneCount<LANES>: SupportedLaneCount,
impl<I, T, const LANES: usize> Index<I> for Simd<T, LANES> where
T: SimdElement,
I: SliceIndex<[T]>,
LaneCount<LANES>: SupportedLaneCount,
type Output = <I as SliceIndex<[T]>>::Output
sourceimpl<K, V> Index<K> for BoxedSlice<K, V> where
K: EntityRef,
impl<K, V> Index<K> for BoxedSlice<K, V> where
K: EntityRef,
Immutable indexing into a BoxedSlice
.
The indexed value must be in the map.
type Output = V
sourceimpl<K, V> Index<K> for PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> Index<K> for PrimaryMap<K, V> where
K: EntityRef,
Immutable indexing into an PrimaryMap
.
The indexed value must be in the map.
type Output = V
sourceimpl<K, V> Index<K> for SecondaryMap<K, V> where
K: EntityRef,
V: Clone,
impl<K, V> Index<K> for SecondaryMap<K, V> where
K: EntityRef,
V: Clone,
Immutable indexing into an SecondaryMap
.
All keys are permitted. Untouched entries have the default value.