maybe-fatal 0.1.0-beta.4

Potentially fatal diagnostics and diagnostic handling for compilers
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

use crate::{Diagnostic, DiagnosticSeverity, code};

/// A [`Diagnostic`] with an explicit [severity](DiagnosticSeverity).
///
/// This is constructed through the [`Diagnostic::classify`] method.
pub struct ClassifiedDiagnostic<S, D = code::DefaultDiscriminant> {
    /// The diagnostic being classified.
    pub(super) inner: Diagnostic<S, D>,

    /// The severity of the diagnostic.
    pub severity: DiagnosticSeverity,
}

impl<S, D> ClassifiedDiagnostic<S, D> {
    /// Changes this diagnostic's severity to [`Error`](DiagnosticSeverity::Error).
    pub const fn make_error(&mut self) -> &mut Self {
        self.severity = DiagnosticSeverity::Error;
        self
    }

    /// Changes this diagnostic's severity to [`Warning`](DiagnosticSeverity::Warning).
    pub const fn make_warning(&mut self) -> &mut Self {
        self.severity = DiagnosticSeverity::Warning;
        self
    }

    /// Changes this diagnostic's severity to [`Advice`](DiagnosticSeverity::Advice).
    pub const fn make_advice(&mut self) -> &mut Self {
        self.severity = DiagnosticSeverity::Advice;
        self
    }

    /// Reports this diagnostic using the given configuration.
    ///
    /// See the [`ariadne`] documentation for more details.
    pub fn report<C>(self, config: ariadne::Config, cache: C) -> std::io::Result<()>
    where
        S: ariadne::Span,
        D: code::Discriminant,
        C: ariadne::Cache<S::SourceId>,
    {
        self.inner.report_with(self.severity, config, cache)
    }
}