[go: up one dir, main page]

miette 2.1.0

Fancy diagnostic reporting library and protocol for us mere mortals who aren't compiler hackers.
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

use std::io;

use thiserror::Error;

use crate::{self as miette, Diagnostic};

/**

Error enum for miette. Used by certain operations in the protocol.
*/
#[derive(Debug, Diagnostic, Error)]
pub enum MietteError {
    /// Wrapper around [std::io::Error]. This is returned when something went
    /// wrong while reading a [crate::Source].
    #[error(transparent)]
    #[diagnostic(code(miette::io_error), url(docsrs))]
    IoError(#[from] io::Error),

    /// Returned when a [crate::SourceSpan] extends beyond the bounds of a given [crate::Source].
    #[error("The given offset is outside the bounds of its Source")]
    #[diagnostic(
        code(miette::span_out_of_bounds),
        help("Double-check your spans. Do you have an off-by-one error?"),
        url(docsrs)
    )]
    OutOfBounds,

    /// Returned when installing a [crate::ReportHandler] failed.
    /// Typically, this will be because [crate::set_printer] was called twice.
    #[error("Failed to install ReportHandler")]
    #[diagnostic(code(miette::set_printer_failed), url(docsrs))]
    SetPrinterFailure,
}