you run miette? You run her code like the software? Oh. Oh! Error code for coder! Error code for One Thousand Lines!
About
miette
is a diagnostic definition library for Rust. It includes a series of
protocols that allow you to hook into its error reporting facilities, and even
write your own error reports! It lets you define error types that can print out
like this (or in any format you like!):
|
|
|
|
The [Diagnostic] trait in miette
is an extension of std::error::Error
that
adds various facilities like [Severity], error codes that could be looked up
by users, and snippet display with support for multiline reports, arbitrary
[Source]s, and pretty printing.
miette
also includes a (lightweight) anyhow
/eyre
-style
[DiagnosticReport] type which can be returned from application-internal
functions to make the ?
experience nicer. It's extra easy to use when using
[DiagnosticResult]!
While the miette
crate bundles some baseline implementations for [Source]
and [DiagnosticReportPrinter], it's intended to define a protocol that other crates
can build on top of to provide rich error reporting, and encourage an
ecosystem that leans on this extra metadata to provide it for others in a way
that's compatible with [std::error::Error]
Installing
Using cargo-edit
:
Example and Guide
/*
You can derive a Diagnostic from any `std::error::Error` type.
`thiserror` is a great way to define them, and plays nicely with `miette`!
*/
use ;
use Error;
/*
Now let's define a function!
Use this DiagnosticResult type (or its expanded version) as the return type
throughout your app (but NOT your libraries! Those should always return concrete
types!).
*/
use DiagnosticResult as Result;
/*
Now to get everything printed nicely, just return a Result<(), DiagnosticReport>
and you're all set!
Note: You can swap out the default reporter for a custom one using `miette::set_reporter()`
*/
And this is the output you'll get if you run this program:
|
|
|
|
License
miette
is released to the Rust community under the MIT license.
It also includes some code taken from eyre
,
also under the MIT license.