context_error 0.2.0

Library to create rich errors to help users understand what the error was and how to fix it
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

/// The kind of an error
pub trait ErrorKind: PartialEq + Default {
    /// Support for a settings object, which can be used to change the behaviour of this error
    /// based on user settings. If not used just use `()`.
    type Settings: Clone;

    /// Get the term describing this error, for example 'error' or 'warning'. This is required to be HTML safe.
    fn descriptor(&self) -> &'static str;

    /// Check if this is an error, and so should block succeeding the operation.
    fn is_error(&self, settings: Self::Settings) -> bool;

    /// Check if this error can be ignored, meaning fully deleted when combining the errors.
    fn ignored(&self, settings: Self::Settings) -> bool;
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum BasicKind {
    #[default]
    Error,
    Warning,
}

impl ErrorKind for BasicKind {
    type Settings = ();
    fn descriptor(&self) -> &'static str {
        match self {
            Self::Error => "error",
            Self::Warning => "warning",
        }
    }
    fn is_error(&self, _settings: Self::Settings) -> bool {
        matches!(self, Self::Error)
    }
    fn ignored(&self, _settings: Self::Settings) -> bool {
        false
    }
}

impl std::fmt::Display for BasicKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.descriptor())
    }
}