error-enum-core 1.0.0-alpha.6

Provide a easy way to define an enum that represents errors with error codes, document comments and several other functionalities.
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

use crate::{ErrorType, Kind, Span};
use alloc::{
    string::{String, ToString as _},
    vec::Vec,
};
use codespan_reporting::{
    diagnostic::{Diagnostic, Label, LabelStyle, Severity},
    files::{Error, SimpleFiles},
    term::{termcolor::Buffer, Config, Styles, StylesWriter},
};
use std::io;

impl From<Kind> for Severity {
    fn from(kind: Kind) -> Self {
        match kind {
            Kind::Error => Severity::Error,
            Kind::Warn => Severity::Warning,
        }
    }
}

pub(crate) type Files<T> =
    SimpleFiles<<<T as ErrorType>::Span as Span>::Uri, <<T as ErrorType>::Span as Span>::Source>;

pub(crate) fn to_codespan_diagnostic<T: ErrorType + ?Sized>(
    value: &T,
) -> (Diagnostic<usize>, Files<T>) {
    let primary_span = value.primary_span().unwrap_or_default();
    let diagnostic = Diagnostic {
        severity: value.kind().into(),
        code: Some(value.code().into()),
        message: value.primary_message().to_string(),
        labels: [Label::new(LabelStyle::Primary, 0, primary_span.range())
            .with_message(value.primary_label())]
        .into(),
        notes: Vec::new(),
    };

    // FIXME: implement my own `Files` to avoid cloning source texts and indexes
    let mut files = SimpleFiles::new();
    files.add(
        primary_span.uri().clone(),
        primary_span.source_text().clone(),
    );

    (diagnostic, files)
}

pub(crate) fn fmt_as_codespan_diagnostic<T: ErrorType + ?Sized>(
    value: &T,
    config: Config,
    styles: Option<&Styles>,
) -> Result<String, Error> {
    let (diagnostic, files) = to_codespan_diagnostic(value);

    if let Some(styles) = styles {
        let mut buf = Buffer::ansi();
        let mut writer = StylesWriter::new(&mut buf, styles);
        codespan_reporting::term::emit_to_write_style(&mut writer, &config, &files, &diagnostic)?;

        String::from_utf8(buf.into_inner())
            .map_err(|e| Error::Io(io::Error::new(io::ErrorKind::InvalidData, e)))
    } else {
        let mut buf = String::new();
        codespan_reporting::term::emit_to_string(&mut buf, &config, &files, &diagnostic)?;

        Ok(buf)
    }
}