indices 0.3.6

Indices provides macros and methods for safely retrieving multiple mutable elements from a mutable slice, addressing scenarios where slice elements would typically require `RefCell` or `Cell` (interior mutability approach).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

/// The error type returned from the `try_indices!` macro.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum TryIndicesError {
    /// The requested index is larger than the length of the input slice.
    IndexOutOfBounds,
    /// The index has been requested twice.
    DuplicateIndex,
}

impl std::error::Error for TryIndicesError {}

impl core::fmt::Display for TryIndicesError {
    #[inline]
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        let variant_name = match *self {
            TryIndicesError::IndexOutOfBounds => "TryIndicesError::IndexOutOfBounds",
            TryIndicesError::DuplicateIndex => "TryIndicesError::DuplicateIndex",
        };
        write!(f, "{}", variant_name)
    }
}

/// The error type returned from the `try_indices_ordered!` macro.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum TryIndicesOrderedError {
    /// The requested index is larger than the length of the input slice.
    IndexOutOfBounds,
    /// The input indices are either not sorted or out of bounds.
    InvalidIndex,
}

impl std::error::Error for TryIndicesOrderedError {}

impl core::fmt::Display for TryIndicesOrderedError {
    #[inline]
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        let variant_name = match *self {
            TryIndicesOrderedError::IndexOutOfBounds => "TryIndicesOrderedError::IndexOutOfBounds",
            TryIndicesOrderedError::InvalidIndex => "TryIndicesOrderedError::InvalidIndex",
        };
        write!(f, "{}", variant_name)
    }
}