error-stack 0.7.0

A context-aware error-handling library that supports arbitrary attached user data
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

use core::{
    error::Error,
    fmt::{Debug, Display},
};

/// Classification of the contents of a [`Frame`], determined by how it was created.
///
/// [`Frame`]: crate::Frame
pub enum FrameKind<'f> {
    /// Frame was created through [`Report::new()`] or [`change_context()`].
    ///
    /// [`Report::new()`]: crate::Report::new
    /// [`change_context()`]: crate::Report::change_context
    Context(&'f (dyn Error + Send + Sync + 'static)),
    /// Frame was created through [`attach()`] or [`attach_opaque()`].
    ///
    /// [`attach()`]: crate::Report::attach
    /// [`attach_opaque()`]: crate::Report::attach_opaque
    Attachment(AttachmentKind<'f>),
}

/// Classification of an attachment which is determined by the method it was created in.
#[non_exhaustive]
pub enum AttachmentKind<'f> {
    /// A generic attachment created through [`attach_opaque()`].
    ///
    /// [`attach_opaque()`]: crate::Report::attach_opaque
    Opaque(&'f (dyn Send + Sync + 'static)),
    /// A printable attachment created through [`attach()`].
    ///
    /// [`attach()`]: crate::Report::attach
    Printable(&'f dyn Printable),
}

// TODO: Replace `Printable` by trait bounds when trait objects for multiple traits are supported.
//   see https://github.com/rust-lang/rfcs/issues/2035
pub trait Printable: Debug + Display + Send + Sync + 'static {}
impl<T> Printable for T where T: Debug + Display + Send + Sync + 'static {}