Trait enso_prelude::IndexMut

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

Used for indexing operations (container[index]) in mutable contexts.

container[index] is actually syntactic sugar for *container.index_mut(index), but only when used as a mutable value. If an immutable value is requested, the Index trait is used instead. This allows nice things such as v[index] = value.

Examples

A very simple implementation of a Balance struct that has two sides, where each can be indexed mutably and immutably.

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

#[derive(Debug)]
enum Side {
    Left,
    Right,
}

#[derive(Debug, PartialEq)]
enum Weight {
    Kilogram(f32),
    Pound(f32),
}

struct Balance {
    pub left: Weight,
    pub right: Weight,
}

impl Index<Side> for Balance {
    type Output = Weight;

    fn index(&self, index: Side) -> &Self::Output {
        println!("Accessing {:?}-side of balance immutably", index);
        match index {
            Side::Left => &self.left,
            Side::Right => &self.right,
        }
    }
}

impl IndexMut<Side> for Balance {
    fn index_mut(&mut self, index: Side) -> &mut Self::Output {
        println!("Accessing {:?}-side of balance mutably", index);
        match index {
            Side::Left => &mut self.left,
            Side::Right => &mut self.right,
        }
    }
}

let mut balance = Balance {
    right: Weight::Kilogram(2.5),
    left: Weight::Pound(1.5),
};

// In this case, `balance[Side::Right]` is sugar for
// `*balance.index(Side::Right)`, since we are only *reading*
// `balance[Side::Right]`, not writing it.
assert_eq!(balance[Side::Right], Weight::Kilogram(2.5));

// However, in this case `balance[Side::Left]` is sugar for
// `*balance.index_mut(Side::Left)`, since we are writing
// `balance[Side::Left]`.
balance[Side::Left] = Weight::Kilogram(3.0);

Required methods

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

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

Panics

May panic if the index is out of bounds.

Implementations on Foreign Types

impl IndexMut<RangeFull> for OsString

pub fn index_mut(&mut self, _index: RangeFull) -> &mut OsStr

impl<T, I, const N: usize> IndexMut<I> for [T; N] where
    [T]: IndexMut<I>, 

pub fn index_mut(&mut self, index: I) -> &mut <[T; N] as Index<I>>::Output

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

pub fn index_mut(&mut self, index: I) -> &mut <I as SliceIndex<[T]>>::Output

impl<I> IndexMut<I> for str where
    I: SliceIndex<str>, 

pub fn index_mut(&mut self, index: I) -> &mut <I as SliceIndex<str>>::Output

impl IndexMut<RangeFrom<usize>> for String

pub fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut str

impl IndexMut<RangeInclusive<usize>> for String

pub fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut str

impl IndexMut<RangeFull> for String

pub fn index_mut(&mut self, _index: RangeFull) -> &mut str

impl<A> IndexMut<usize> for VecDeque<A>

pub fn index_mut(&mut self, index: usize) -> &mut A

impl<T, I, A> IndexMut<I> for Vec<T, A> where
    I: SliceIndex<[T]>,
    A: Allocator, 

pub fn index_mut(&mut self, index: I) -> &mut <Vec<T, A> as Index<I>>::Output

impl IndexMut<Range<usize>> for String

pub fn index_mut(&mut self, index: Range<usize>) -> &mut str

impl IndexMut<RangeToInclusive<usize>> for String

pub fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut str

impl IndexMut<RangeTo<usize>> for String

pub fn index_mut(&mut self, index: RangeTo<usize>) -> &mut str

impl<'a, K, V, S> IndexMut<&'a <K as WeakElement>::Strong> for PtrWeakKeyHashMap<K, V, S> where
    S: BuildHasher,
    K: WeakElement,
    <K as WeakElement>::Strong: Deref, 

pub fn index_mut(
    &mut self,
    index: &'a <K as WeakElement>::Strong
) -> &mut <PtrWeakKeyHashMap<K, V, S> as Index<&'a <K as WeakElement>::Strong>>::Output

impl<T, R, C, S> IndexMut<(usize, usize)> for Matrix<T, R, C, S> where
    C: Dim,
    T: Scalar,
    R: Dim,
    S: StorageMut<T, R, C>, 

pub fn index_mut(&mut self, ij: (usize, usize)) -> &mut T

impl<T> IndexMut<usize> for Quaternion<T> where
    T: Scalar, 

pub fn index_mut(&mut self, i: usize) -> &mut T

impl<T, const D: usize> IndexMut<usize> for Point<T, D> where
    T: Scalar, 

pub fn index_mut(
    &mut self,
    i: usize
) -> &mut <Point<T, D> as Index<usize>>::Output

impl<T, R, C, S> IndexMut<usize> for Matrix<T, R, C, S> where
    C: Dim,
    T: Scalar,
    R: Dim,
    S: StorageMut<T, R, C>, 

pub fn index_mut(&mut self, i: usize) -> &mut T

impl<T> IndexMut<usize> for DualQuaternion<T> where
    T: SimdRealField, 

pub fn index_mut(&mut self, i: usize) -> &mut T

impl<T, const D: usize> IndexMut<(usize, usize)> for Transform<T, TGeneral, D> where
    T: RealField,
    Const<D>: DimNameAdd<Const<1_usize>>,
    DefaultAllocator: Allocator<T, <Const<D> as DimNameAdd<Const<1_usize>>>::Output, <Const<D> as DimNameAdd<Const<1_usize>>>::Output>, 

pub fn index_mut(&mut self, ij: (usize, usize)) -> &mut T

Implementors

impl<'a, K, V, S, Q> IndexMut<&'a Q> for WeakKeyHashMap<K, V, S> where
    S: BuildHasher,
    K: WeakKey,
    Q: Eq + Hash + ?Sized,
    <K as WeakKey>::Key: Borrow<Q>, 

pub fn index_mut(
    &mut self,
    index: &'a Q
) -> &mut <WeakKeyHashMap<K, V, S> as Index<&'a Q>>::Output

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

pub fn index_mut(
    &mut self,
    index: I
) -> &mut <I as SliceIndex<[<A as Array>::Item]>>::Output