tighterror 0.0.22

A minimalistic error representation framework.
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

use crate::{Category, Kind};
use core::fmt::{Debug, Display};

/// The trait of variant types.
pub trait VariantType: Clone + Debug + Display {
    /// The underlying Rust type of error kind.
    ///
    /// A concrete builtin type, e.g., `u8`.
    type R;

    /// The error category concrete type.
    type Category: Category<R = Self::R>;

    /// The error kind concrete type.
    type Kind: Kind<R = Self::R, Category = Self::Category>;

    /// The error category of the variant type.
    const CATEGORY: Self::Category;

    /// The error kind of the variant type.
    const KIND: Self::Kind;

    /// The concrete type name.
    const NAME: &'static str;

    /// Returns the error category of the variant type.
    ///
    /// This is a convenience method that returns [CATEGORY](Self::CATEGORY).
    #[inline]
    fn category(&self) -> Self::Category {
        Self::CATEGORY
    }

    /// Returns the error kind of the variant type.
    ///
    /// This is a convenience method that returns [KIND](Self::KIND).
    #[inline]
    fn kind(&self) -> Self::Kind {
        Self::KIND
    }

    /// Returns the variant type name.
    ///
    /// This is a convenience method that returns [NAME](Self::NAME).
    #[inline]
    fn name(&self) -> &'static str {
        Self::NAME
    }
}