mago-reporting 0.26.1

Structured error and diagnostic reporting utilities.
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

use termcolor::WriteColor;

use mago_interner::ThreadedInterner;
use mago_source::SourceManager;

use crate::IssueCollection;
use crate::Level;
use crate::error::ReportingError;
use crate::reporter::ReportingFormat;

mod utils;

pub mod checkstyle;
pub mod codespan;
pub mod count;
pub mod emacs;
pub mod github;
pub mod gitlab;
pub mod json;

pub trait Emitter {
    fn emit(
        &self,
        writer: &mut dyn WriteColor,
        sources: &SourceManager,
        interner: &ThreadedInterner,
        issues: IssueCollection,
    ) -> Result<Option<Level>, ReportingError>;
}

impl<T> Emitter for T
where
    T: Fn(
        &mut dyn WriteColor,
        &SourceManager,
        &ThreadedInterner,
        IssueCollection,
    ) -> Result<Option<Level>, ReportingError>,
{
    fn emit(
        &self,
        writer: &mut dyn WriteColor,
        sources: &SourceManager,
        interner: &ThreadedInterner,
        issues: IssueCollection,
    ) -> Result<Option<Level>, ReportingError> {
        self(writer, sources, interner, issues)
    }
}

impl Emitter for ReportingFormat {
    fn emit(
        &self,
        writer: &mut dyn WriteColor,
        sources: &SourceManager,
        interner: &ThreadedInterner,
        issues: IssueCollection,
    ) -> Result<Option<Level>, ReportingError> {
        match self {
            ReportingFormat::Rich => codespan::rich_format.emit(writer, sources, interner, issues),
            ReportingFormat::Medium => codespan::medium_format.emit(writer, sources, interner, issues),
            ReportingFormat::Short => codespan::short_format.emit(writer, sources, interner, issues),
            ReportingFormat::Github => github::github_format.emit(writer, sources, interner, issues),
            ReportingFormat::Gitlab => gitlab::gitlab_format.emit(writer, sources, interner, issues),
            ReportingFormat::Json => json::json_format.emit(writer, sources, interner, issues),
            ReportingFormat::Count => count::count_format.emit(writer, sources, interner, issues),
            ReportingFormat::Checkstyle => checkstyle::checkstyle_format.emit(writer, sources, interner, issues),
            ReportingFormat::Emacs => emacs::emacs_format.emit(writer, sources, interner, issues),
        }
    }
}