std::ops::Index - Rust
Description: API documentation for the Rust `Index` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Index

# Trait std::ops::Index 1.0.0 [−] [src]

    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);Run

## 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> Index<usize> for [T]`
- `impl<T> Index<Range<usize>> for [T]`
- `impl<T> Index<RangeTo<usize>> for [T]`
- `impl<T> Index<RangeFrom<usize>> for [T]`
- `impl<T> Index<RangeFull> for [T]`
- `impl<T> Index<RangeInclusive<usize>> for [T]`
- `impl<T> Index<RangeToInclusive<usize>> for [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 String`
- `impl Index<RangeTo<usize>> for String`
- `impl Index<RangeFrom<usize>> for String`
- `impl Index<RangeFull> for String`
- `impl Index<RangeInclusive<usize>> for String`
- `impl Index<RangeToInclusive<usize>> for String`
- `impl<T> Index<usize> for Vec<T>`
- `impl<T> Index<Range<usize>> for Vec<T>`
- `impl<T> Index<RangeTo<usize>> for Vec<T>`
- `impl<T> Index<RangeFrom<usize>> for Vec<T>`
- `impl<T> Index<RangeFull> for Vec<T>`
- `impl<T> Index<RangeInclusive<usize>> for Vec<T>`
- `impl<T> Index<RangeToInclusive<usize>> for Vec<T>`
- `impl<A> Index<usize> for VecDeque<A>`
- `impl<'a, K, Q: ?Sized, V, S> Index<&'a Q> for HashMap<K, V, S> where K: Eq + Hash + Borrow<Q>, Q: Eq + Hash, S: BuildHasher`
- `impl Index<RangeFull> for CString`
- `impl Index<RangeFull> for OsString`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)