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

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

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) -> &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`

Performs the indexing (`container[index]`) operation.

## Implementors

- [src]
  `impl Index<RangeFrom<usize>> for str type Output = str;`
- [src]
  `impl Index<RangeToInclusive<usize>> for str type Output = str;`
- [src]
  `impl Index<RangeInclusive<usize>> for str type Output = str;`
- [src]
  `impl Index<RangeFull> for str type Output = str;`
- [src]
  `impl Index<RangeTo<usize>> for str type Output = str;`
- [src]
  `impl Index<Range<usize>> for str type Output = str;`
- [src]
  `impl<T, I> Index<I> for [T] where
  I: SliceIndex<[T]>, type Output = <I as SliceIndex<[T]>>::Output;`
- [src]
  `impl<T> Index<usize> for Vec<T> type Output = T;`
- [src]
  `impl Index<RangeInclusive<usize>> for String type Output = str;`
- [src]
  `impl Index<RangeToInclusive<usize>> for String type Output = str;`
- [src]
  `impl Index<Range<usize>> for String type Output = str;`
- [src]
  `impl<T> Index<Range<usize>> for Vec<T> type Output = [T];`
- [src]
  `impl<T> Index<RangeTo<usize>> for Vec<T> type Output = [T];`
- [src]
  `impl<'a, K, Q, V> Index<&'a Q> for BTreeMap<K, V> where
  K: Ord + Borrow<Q>,
  Q: Ord + ?Sized, type Output = V;`
- [src]
  `impl<T> Index<RangeToInclusive<usize>> for Vec<T> type Output = [T];`
- [src]
  `impl<A> Index<usize> for VecDeque<A> type Output = A;`
- [src]
  `impl<T> Index<RangeFull> for Vec<T> type Output = [T];`
- [src]
  `impl Index<RangeTo<usize>> for String type Output = str;`
- [src]
  `impl Index<RangeFull> for String type Output = str;`
- [src]
  `impl Index<RangeFrom<usize>> for String type Output = str;`
- [src]
  `impl<T> Index<RangeFrom<usize>> for Vec<T> type Output = [T];`
- [src]
  `impl<T> Index<RangeInclusive<usize>> for Vec<T> type Output = [T];`
- [src]
  `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, type Output = V;`
- [src]
  `impl Index<RangeFull> for CString type Output = CStr;`
- [src]
  `impl Index<RangeFull> for OsString type Output = OsStr;`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)