miden-utils-diagnostics 0.23.0

Diagnostic infrastructure used in the Miden assembler and VM
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

//! Rendering and error reporting implementation details.
use core::fmt;

pub use miette::{
    DebugReportHandler, JSONReportHandler, NarratableReportHandler, ReportHandler, set_hook,
};
#[cfg(feature = "std")]
pub use miette::{GraphicalReportHandler, GraphicalTheme};

// set_panic_hook is only available with fancy or fancy-no-backtrace features,
// not with fancy-no-syscall. Since we use fancy-no-syscall to avoid syscall
// dependencies, we provide a no-op stub for compatibility.
#[cfg(feature = "std")]
pub fn set_panic_hook() {
    // No-op when using fancy-no-syscall feature
    // The fancy-no-syscall feature doesn't include panic hook support
}

pub type ReportHandlerOpts = miette::MietteHandlerOpts;

#[cfg(feature = "std")]
pub type DefaultReportHandler = GraphicalReportHandler;

#[cfg(not(feature = "std"))]
pub type DefaultReportHandler = miette::DebugReportHandler;

/// A type that can be used to render a [super::Diagnostic] via [core::fmt::Display]
pub struct PrintDiagnostic<D, R = DefaultReportHandler> {
    handler: R,
    diag: D,
}

impl<D: AsRef<dyn super::Diagnostic>> PrintDiagnostic<D> {
    pub fn new(diag: D) -> Self {
        Self { handler: Default::default(), diag }
    }
    #[cfg(feature = "std")]
    pub fn new_without_color(diag: D) -> Self {
        Self {
            handler: DefaultReportHandler::new_themed(GraphicalTheme::none()),
            diag,
        }
    }
    #[cfg(not(feature = "std"))]
    pub fn new_without_color(diag: D) -> Self {
        Self::new(diag)
    }
}

impl<D: AsRef<dyn super::Diagnostic>> PrintDiagnostic<D, NarratableReportHandler> {
    pub fn narrated(diag: D) -> Self {
        Self {
            handler: NarratableReportHandler::default(),
            diag,
        }
    }
}

impl<D: AsRef<dyn super::Diagnostic>> PrintDiagnostic<D, JSONReportHandler> {
    pub fn json(diag: D) -> Self {
        Self { handler: JSONReportHandler, diag }
    }
}

impl<D: AsRef<dyn super::Diagnostic>> fmt::Display for PrintDiagnostic<D> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.handler.render_report(f, self.diag.as_ref())
    }
}

impl<D: AsRef<dyn super::Diagnostic>> fmt::Display for PrintDiagnostic<D, NarratableReportHandler> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.handler.render_report(f, self.diag.as_ref())
    }
}

impl<D: AsRef<dyn super::Diagnostic>> fmt::Display for PrintDiagnostic<D, JSONReportHandler> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.handler.render_report(f, self.diag.as_ref())
    }
}