sdml-errors 0.4.1

Simple Domain Modeling Language (SDML) errors and diagnostics.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

/*!
Provides project-wide diagnostic types that describe more fine-grained error conditions..

 */

use crate::FileId;
use codespan_reporting::diagnostic::Severity;
use std::fmt::Display;

// ------------------------------------------------------------------------------------------------
// Public Types  Diagnostics and Reporter
// ------------------------------------------------------------------------------------------------

///
/// The type of structured diagnostic reports.
///
pub type Diagnostic = codespan_reporting::diagnostic::Diagnostic<FileId>;

// ------------------------------------------------------------------------------------------------
// Diagnostic Level
// ------------------------------------------------------------------------------------------------

///
/// This value determines the level of diagnostics to be emitted by **any** reporter.
///
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum SeverityFilter {
    Bug,
    Error,
    Warning,
    Note,
    Help,
    None,
}

// ------------------------------------------------------------------------------------------------
// Implementations
// ------------------------------------------------------------------------------------------------

impl Default for SeverityFilter {
    fn default() -> Self {
        Self::Error
    }
}

impl Display for SeverityFilter {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Self::Bug => "=bugs",
                Self::Error => ">=errors",
                Self::Warning => ">=warnings",
                Self::Note => ">=notes",
                Self::Help => ">=help",
                Self::None => "none",
            }
        )
    }
}

impl From<Severity> for SeverityFilter {
    fn from(value: Severity) -> Self {
        match value {
            Severity::Bug => Self::Bug,
            Severity::Error => Self::Error,
            Severity::Warning => Self::Warning,
            Severity::Note => Self::Note,
            Severity::Help => Self::Help,
        }
    }
}

// ------------------------------------------------------------------------------------------------
// Modules
// ------------------------------------------------------------------------------------------------

pub mod codes;
pub use codes::ErrorCode;

pub mod color;
pub use color::UseColor;

pub mod functions;

pub mod reporter;
pub use reporter::{Reporter, StandardStreamReporter};