1.0.0[−][src]Trait tract_hir::internal::tract_downcast_rs::__std::ops::Index

#[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) -> &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

type Output: ?Sized

The returned type after indexing.

Loading content...

Required methods

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

Performs the indexing (container[index]) operation.

Loading content...

Implementations on Foreign Types

impl<I> Index<I> for str where
    I: SliceIndex<str>, [src]

type Output = <I as SliceIndex<str>>::Output

impl<T, I> Index<I> for [T] where
    I: SliceIndex<[T]>, [src]

type Output = <I as SliceIndex<[T]>>::Output

impl<'_, K, Q, V, S> Index<&'_ Q> for HashMap<K, V, S> where
    K: Eq + Hash + Borrow<Q>,
    Q: Eq + Hash + ?Sized,
    S: BuildHasher, 

type Output = V

fn index(&self, key: &Q) -> &Vⓘ

Notable traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the HashMap.

impl<'input, Endian> Index<RangeFrom<usize>> for EndianSlice<'input, Endian> where
    Endian: Endianity, 

type Output = [u8]

impl<'input, Endian> Index<usize> for EndianSlice<'input, Endian> where
    Endian: Endianity, 

type Output = u8

impl<B> Index<usize> for BitVec<B> where
    B: BitBlock, 

type Output = bool

impl<'input, Endian> Index<usize> for EndianSlice<'input, Endian> where
    Endian: Endianity, 

type Output = u8

impl<'input, Endian> Index<RangeFrom<usize>> for EndianSlice<'input, Endian> where
    Endian: Endianity, 

type Output = [u8]

impl<A, I> Index<I> for SmallVec<A> where
    A: Array,
    I: SliceIndex<[<A as Array>::Item]>, 

type Output = <I as SliceIndex<[<A as Array>::Item]>>::Output

Loading content...

Implementors

impl Index<()> for ValueProxy[src]

type Output = IntProxy

fn index(&self, _: ()) -> &IntProxy[src]

Returns the RootValueProxy corresponding to the given index.

impl Index<usize> for ElementProxy[src]

type Output = ElementProxy

fn index(&self, index: usize) -> &ElementProxy[src]

Returns the ElementProxy corresponding to the given index.

impl Index<usize> for ShapeProxy[src]

type Output = DimProxy

fn index(&self, index: usize) -> &DimProxy[src]

Returns the DimProxy corresponding to the given index.

impl Index<usize> for ValueProxy[src]

type Output = ElementProxy

fn index(&self, index: usize) -> &ElementProxy[src]

Returns the ElementProxy corresponding to the given index.

impl Index<usize> for Dim<[usize; 0]>[src]

type Output = usize

impl Index<usize> for Dim<[usize; 1]>[src]

type Output = usize

impl Index<usize> for Dim<[usize; 2]>[src]

type Output = usize

impl Index<usize> for Dim<[usize; 3]>[src]

type Output = usize

impl Index<usize> for Dim<[usize; 4]>[src]

type Output = usize

impl Index<usize> for Dim<[usize; 5]>[src]

type Output = usize

impl Index<usize> for Dim<[usize; 6]>[src]

type Output = usize

impl Index<usize> for Dim<IxDynImpl>[src]

type Output = <IxDynImpl as Index<usize>>::Output

impl Index<Range<usize>> for String[src]

type Output = str

impl Index<RangeFrom<usize>> for String[src]

type Output = str

impl Index<RangeFrom<usize>> for CStr[src]

type Output = CStr

impl Index<RangeFull> for String[src]

type Output = str

impl Index<RangeFull> for CString[src]

type Output = CStr

impl Index<RangeFull> for OsString[src]

type Output = OsStr

impl Index<RangeInclusive<usize>> for String[src]

type Output = str

impl Index<RangeTo<usize>> for String[src]

type Output = str

impl Index<RangeToInclusive<usize>> for String[src]

type Output = str

impl<'_, K, Q, V> Index<&'_ Q> for BTreeMap<K, V> where
    K: Ord + Borrow<Q>,
    Q: Ord + ?Sized, [src]

type Output = V

fn index(&self, key: &Q) -> &Vⓘ

Notable traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;
[src]

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the BTreeMap.

impl<'_, K, Q, V, S> Index<&'_ Q> for tract_hir::internal::HashMap<K, V, S> where
    K: Eq + Hash + Borrow<Q>,
    Q: Eq + Hash + ?Sized,
    S: BuildHasher, [src]

type Output = V

fn index(&self, key: &Q) -> &Vⓘ

Notable traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;
[src]

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the HashMap.

impl<A> Index<usize> for VecDeque<A>[src]

type Output = A

impl<J> Index<J> for IxDynImpl where
    [usize]: Index<J>, [src]

type Output = <[usize] as Index<J>>::Output

impl<S, D, I> Index<I> for ArrayBase<S, D> where
    D: Dimension,
    I: NdIndex<D>,
    S: Data, [src]

Access the element at index.

Panics if index is out of bounds.

type Output = <S as RawData>::Elem

impl<T, I> Index<I> for Vec<T> where
    I: SliceIndex<[T]>, [src]

type Output = <I as SliceIndex<[T]>>::Output

Loading content...