Trait std::ops::IndexMut

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

The IndexMut trait is used to specify the functionality of indexing operations like container[index], when used in a mutable context.

Examples

A trivial implementation of IndexMut for a type Foo. When &mut Foo[2] happens, it ends up calling index_mut, and therefore, main prints Mutable indexing with 2!.

use std::ops::{Index, IndexMut};

#[derive(Copy, Clone)]
struct Foo;

impl Index<usize> for Foo {
    type Output = Foo;

    fn index(&self, _index: usize) -> &Foo {
        self
    }
}

impl IndexMut<usize> for Foo {
    fn index_mut(&mut self, index: usize) -> &mut Foo {
        println!("Mutable indexing with {}!", index);
        self
    }
}

fn main() {
    &mut Foo[2];
}

Required Methods

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

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

Implementors

• impl<T> IndexMut<usize> for [T]
• impl<T> IndexMut<Range<usize>> for [T]
• impl<T> IndexMut<RangeTo<usize>> for [T]
• impl<T> IndexMut<RangeFrom<usize>> for [T]
• impl<T> IndexMut<RangeFull> for [T]
• impl<T> IndexMut<RangeInclusive<usize>> for [T]
• impl<T> IndexMut<RangeToInclusive<usize>> for [T]
• impl IndexMut<Range<usize>> for str
• impl IndexMut<RangeTo<usize>> for str
• impl IndexMut<RangeFrom<usize>> for str
• impl IndexMut<RangeFull> for str
• impl IndexMut<RangeInclusive<usize>> for str
• impl IndexMut<RangeToInclusive<usize>> for str
• impl IndexMut<Range<usize>> for String
• impl IndexMut<RangeTo<usize>> for String
• impl IndexMut<RangeFrom<usize>> for String
• impl IndexMut<RangeFull> for String
• impl IndexMut<RangeInclusive<usize>> for String
• impl IndexMut<RangeToInclusive<usize>> for String
• impl<T> IndexMut<usize> for Vec<T>
• impl<T> IndexMut<Range<usize>> for Vec<T>
• impl<T> IndexMut<RangeTo<usize>> for Vec<T>
• impl<T> IndexMut<RangeFrom<usize>> for Vec<T>
• impl<T> IndexMut<RangeFull> for Vec<T>
• impl<T> IndexMut<RangeInclusive<usize>> for Vec<T>
• impl<T> IndexMut<RangeToInclusive<usize>> for Vec<T>
• impl<A> IndexMut<usize> for VecDeque<A>