Trait std::ops::Index

pub trait Index<Idx> where Idx: ?Sized {
    type Output: ?Sized;
    fn index(&self, index: Idx) -> &Self::Output;
}

The Index trait is used to specify the functionality of indexing operations like container[index] when used in an immutable context.

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 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) -> &usize {
        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

type Output: ?Sized

The returned type after indexing

Required Methods

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

The method for the indexing (container[index]) operation

Implementors

• impl<T, I> Index<I> for [T] where I: SliceIndex<T>
• impl Index<Range<usize>> for str
• impl Index<RangeTo<usize>> for str
• impl Index<RangeFrom<usize>> for str
• impl Index<RangeFull> for str
• impl Index<RangeInclusive<usize>> for str
• impl Index<RangeToInclusive<usize>> for str
• impl<'a, K, Q, V> Index<&'a Q> for BTreeMap<K, V> where K: Ord + Borrow<Q>,
        Q: Ord + ?Sized
• impl Index<Range<usize>> for std::string::String
• impl Index<RangeTo<usize>> for std::string::String
• impl Index<RangeFrom<usize>> for std::string::String
• impl Index<RangeFull> for std::string::String
• impl Index<RangeInclusive<usize>> for std::string::String
• impl Index<RangeToInclusive<usize>> for std::string::String
• impl<T> Index<usize> for std::vec::Vec<T>
• impl<T> Index<Range<usize>> for std::vec::Vec<T>
• impl<T> Index<RangeTo<usize>> for std::vec::Vec<T>
• impl<T> Index<RangeFrom<usize>> for std::vec::Vec<T>
• impl<T> Index<RangeFull> for std::vec::Vec<T>
• impl<T> Index<RangeInclusive<usize>> for std::vec::Vec<T>
• impl<T> Index<RangeToInclusive<usize>> for std::vec::Vec<T>
• impl<A> Index<usize> for VecDeque<A>
• impl Index<RangeFull> for CString
• impl Index<RangeFull> for OsString