berkus
/
miette
mirror of https://github.com/zkat/miette.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add error code aliases 

miette can't do this yet, but I can still do it by hand!
This commit is contained in:
Kat Marchán 2021-08-22 00:22:38 -07:00
parent 196ef51417
commit eb4ea3423a
No known key found for this signature in database
GPG Key ID: AEB529C08A3C7E9E
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/error.rs
View File

@ -13,6 +13,7 @@ pub enum MietteError {
/// wrong while reading a [crate::Source].
#[error(transparent)]
#[diagnostic(code(miette::io_error))]
#[doc(alias = "miette::io_error")]
IoError(#[from] io::Error),
/// Returned when a [crate::SourceSpan] extends beyond the bounds of a given [crate::Source].
@ -21,11 +22,13 @@ pub enum MietteError {
code(miette::span_out_of_bounds),
help("Double-check your spans. Do you have an off-by-one error?")
)]
#[doc(alias = "miette::span_out_of_bounds")]
OutOfBounds,
/// Returned when installing a [crate::DiagnosticReportPrinter] failed.
/// Typically, this will be because [crate::set_printer] was called twice.
#[error("Failed to install DiagnosticReportPrinter")]
#[diagnostic(code(miette::set_printer_failed))]
#[doc(alias = "miette::set_printer_failed")]
SetPrinterFailure,
}