general_stable_vec 0.15.0

A Vec implementation with stable indices
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
44
45
46
47
48
49
50
51
52

//! Errors and related types.

use std::slice::GetDisjointMutError;

use thiserror::Error;

/// The error type.
#[derive(Debug, Error)]
pub enum Error {
    /// The given index is not mapped to any element.
    #[error("the given index {index} is not mapped to any element")]
    UnmappedIndex {
        /// The index.
        index: usize,
    },

    /// The given indices contain an overlapping pair of indices.
    #[error("the given indices contain an overlapping pair of indices")]
    OverlappingIndices,

    /// The given index is already mapped to an element.
    #[error("the given index {index} is already mapped to an element")]
    IndexAlreadyInUse {
        /// The index.
        index: usize,
    },

    /// The given index is not the next available insertion index.
    #[error(
        "The given index {actual_index} is not the next available insertion index {expected_index}"
    )]
    NotTheNextAvailableInsertionIndex {
        /// The expected next available insertion index.
        expected_index: usize,
        /// The given invalid insertion index.
        actual_index: usize,
    },
}

impl From<GetDisjointMutError> for Error {
    fn from(value: GetDisjointMutError) -> Self {
        match value {
            GetDisjointMutError::IndexOutOfBounds => {
                unreachable!("We always want to report the index")
            }
            GetDisjointMutError::OverlappingIndices => Self::OverlappingIndices,
        }
    }
}

/// A shortcut result type using this crate's error type.
pub type Result<T> = std::result::Result<T, Error>;