x-map 0.1.2

Extended map/vector structures for Rust
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

//! Module containing code for various errors that may need to be handled.

use std::error::Error;
use std::fmt::{Debug, Display, Formatter, Write};

pub enum MapErrorKind {
    AllocationError,
    AccessError
}

/// A struct handling error reporting for the `CIndexMap` type.
///
/// This error contains the kind of error that the map ran into, and the message to display
/// when displaying the error.
pub struct CIndexMapError {
    /// A static string containing the message associated with the error.
    message: &'static str,

    /// A `MapErrorKind`, containing the type of error that the map encountered.
    kind: MapErrorKind
}

impl CIndexMapError {
    /// Constructs a new CIndexMapError.
    ///
    /// This is only used within `x-map`, and cannot be called externally.
    pub(in crate) fn new(
        kind: MapErrorKind,
        message: &'static str
    ) -> CIndexMapError {
        CIndexMapError {
            kind,
            message
        }
    }
}

impl Debug for CIndexMapError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.message)
    }
}

impl Display for CIndexMapError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.message)
    }
}

impl Error for CIndexMapError {}