Struct miette::Error [−][src]
pub struct Error { /* fields omitted */ }
Expand description
Core Diagnostic wrapper type.
Implementations
Create a new error object from any error type.
The error type must be thread safe and 'static
, so that the Report
will be as well.
If the error type does not provide a backtrace, a backtrace will be created here to ensure that a backtrace exists.
Create a new error object from a printable error message.
If the argument implements std::error::Error, prefer Report::new
instead which preserves the underlying error’s cause chain and
backtrace. If the argument may or may not implement std::error::Error
now or in the future, use miette!(err)
which handles either way
correctly.
Report::msg("...")
is equivalent to miette!("...")
but occasionally
convenient in places where a function is preferable over a macro, such
as iterator or stream combinators:
use miette::{Report, Result};
use futures::stream::{Stream, StreamExt, TryStreamExt};
async fn demo<S>(stream: S) -> Result<Vec<Output>>
where
S: Stream<Item = Input>,
{
stream
.then(ffi::do_some_work) // returns Result<Output, &str>
.map_err(Report::msg)
.try_collect()
.await
}
Create a new error from an error message to wrap the existing error.
For attaching a higher level error message to a Result
as it is propagated, the
crate::WrapErr extension trait may be more convenient than this function.
The primary reason to use error.wrap_err(...)
instead of result.wrap_err(...)
via the
WrapErr
trait would be if the message needs to depend on some data held by the underlying
error:
An iterator of the chain of source errors contained by this Report.
This iterator will visit every error in the cause chain of this error object, beginning with the error that this error object was created from.
Example
use miette::Report;
use std::io;
pub fn underlying_io_error_kind(error: &Report) -> Option<io::ErrorKind> {
for cause in error.chain() {
if let Some(io_error) = cause.downcast_ref::<io::Error>() {
return Some(io_error.kind());
}
}
None
}
The lowest level cause of this error — this error’s cause’s cause’s cause etc.
The root cause is the last error in the iterator produced by
chain()
.
Returns true if E
is the type held by this error object.
For errors constructed from messages, this method returns true if E
matches the type of
the message D
or the type of the error on which the message has been attached. For
details about the interaction between message and downcasting, see here.
Attempt to downcast the error object to a concrete type.
Downcast this error object by reference.
Example
// If the error was caused by redaction, then return a tombstone instead
// of the content.
match root_cause.downcast_ref::<DataStoreError>() {
Some(DataStoreError::Censored(_)) => Ok(Poll::Ready(REDACTED_CONTENT)),
None => Err(error),
}
Downcast this error object by mutable reference.
Get a reference to the Handler for this Report.
Get a mutable reference to the Handler for this Report.
Trait Implementations
Performs the conversion.
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Report
impl !UnwindSafe for Report
Blanket Implementations
Mutably borrows from an owned value. Read more
Set the foreground color generically Read more
Set the background color generically. Read more
Change the foreground color to black
Change the foreground color to black
Change the foreground color to red
Change the foreground color to red
Change the foreground color to green
Change the foreground color to green
Change the foreground color to yellow
Change the foreground color to yellow
Change the foreground color to blue
Change the foreground color to blue
Change the foreground color to magenta
Change the foreground color to magenta
Change the foreground color to purple
Change the foreground color to purple
Change the foreground color to cyan
Change the foreground color to cyan
Change the foreground color to white
Change the foreground color to white
Change the foreground color to bright black
Change the foreground color to bright black
Change the foreground color to bright red
Change the foreground color to bright red
Change the foreground color to bright green
Change the foreground color to bright green
Change the foreground color to bright yellow
Change the foreground color to bright yellow
Change the foreground color to bright blue
Change the foreground color to bright blue
Change the foreground color to bright magenta
Change the foreground color to bright magenta
Change the foreground color to bright purple
Change the foreground color to bright purple
Change the foreground color to bright cyan
Change the foreground color to bright cyan
Change the foreground color to bright white
Change the foreground color to bright white
Make the text bold
Make the text dim
Make the text italicized
Make the text italicized
Make the text blink
Make the text blink (but fast!)
Swap the foreground and background colors
Hide the text
Cross out the text
fn color<Color>(&'a self, color: Color) -> FgDynColorDisplay<'a, Color, Self> where
Color: DynColor,
fn color<Color>(&'a self, color: Color) -> FgDynColorDisplay<'a, Color, Self> where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read more
fn on_color<Color>(&'a self, color: Color) -> BgDynColorDisplay<'a, Color, Self> where
Color: DynColor,
fn on_color<Color>(&'a self, color: Color) -> BgDynColorDisplay<'a, Color, Self> where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more
fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&'a self
) -> FgColorDisplay<'a, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&'a self
) -> FgColorDisplay<'a, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&'a self
) -> BgColorDisplay<'a, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&'a self
) -> BgColorDisplay<'a, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
Sets the foreground color to an RGB value.
Sets the background color to an RGB value.