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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use crate::{ErrorType, Kind, Span};
use alloc::{string::String, vec::Vec};
use ariadne::{Config, Label, Report, ReportKind};
use core::{fmt, iter};
use std::io;

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

pub(crate) struct SpanWrapper<T>(T);

impl<T: Span> ariadne::Span for SpanWrapper<T> {
    type SourceId = T::Uri;

    fn source(&self) -> &Self::SourceId {
        self.0.uri()
    }
    fn start(&self) -> usize {
        Span::start(&self.0)
    }
    fn end(&self) -> usize {
        Span::end(&self.0)
    }
}

type SourceEntry<T> = (
    <<T as ErrorType>::Span as Span>::Uri,
    ariadne::Source<<<T as ErrorType>::Span as Span>::Source>,
);

struct Cache<T: ErrorType + ?Sized> {
    sources: Vec<SourceEntry<T>>,
}

impl<T: ErrorType + ?Sized> FromIterator<T::Span> for Cache<T> {
    fn from_iter<I: IntoIterator<Item = T::Span>>(iter: I) -> Self {
        let sources = iter
            .into_iter()
            .map(
                |span| -> (
                    <T::Span as Span>::Uri,
                    ariadne::Source<<T::Span as Span>::Source>,
                ) {
                    (
                        span.uri().clone(),
                        ariadne::Source::from(span.source_text().clone()),
                    )
                },
            )
            .collect();
        Self { sources }
    }
}

impl<T: ErrorType + ?Sized> ariadne::Cache<<T::Span as Span>::Uri> for Cache<T> {
    type Storage = <T::Span as Span>::Source;

    fn fetch(
        &mut self,
        id: &<T::Span as Span>::Uri,
    ) -> Result<&ariadne::Source<Self::Storage>, impl fmt::Debug> {
        self.sources
            .iter()
            .find(|(uri, _)| uri == id)
            .map(|(_, source)| source)
            .ok_or("Source not found")
    }

    fn display<'a>(&self, id: &'a <T::Span as Span>::Uri) -> Option<impl fmt::Display + 'a> {
        self.sources
            .iter()
            .find(|(uri, _)| uri == id)
            .map(|(uri, _)| uri)
            .cloned()
    }
}

pub(crate) fn to_ariadne_report<T: ErrorType + ?Sized>(
    error: &T,
    buf: &mut impl io::Write,
    config: Config,
) -> Result<(), io::Error> {
    let primary_span = error.primary_span().unwrap_or_default();
    let primary_message = error.primary_message();
    let cache: Cache<T> = Cache::from_iter(iter::once(primary_span.clone()));
    Report::build(error.kind().into(), SpanWrapper(primary_span.clone()))
        .with_code(error.code())
        .with_message(primary_message)
        .with_label(Label::new(SpanWrapper(primary_span)).with_message(error.primary_label()))
        .with_config(config)
        .finish()
        .write(cache, buf)
}
pub(crate) fn fmt_as_ariadne_report<T: ErrorType + ?Sized>(
    error: &T,
    config: Config,
) -> Result<String, io::Error> {
    let mut result = Vec::new();
    to_ariadne_report(error, &mut result, config)?;
    String::from_utf8(result).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}