oopsie 0.1.0-rc.20

Ergonomic, structured error handling: context selectors, traced errors, and rich colorized reports
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

//! Compile-pass coverage for the hover-documentation `use` blocks the derive
//! and the `#[oopsie]` attribute macro emit: the fixtures below exercise
//! every `#[oopsie(...)]` keyword at its scope, so a keyword that parses but
//! has no entry in `oopsie::__private::documented` fails this build with an
//! unresolved import.

#![cfg_attr(
    feature = "unstable-error-generic-member-access",
    feature(error_generic_member_access)
)]
#![allow(
    unused,
    clippy::all,
    reason = "derive-macro test fixtures intentionally trip style lints"
)]

use std::io;

use oopsie::{Backtrace, Contextual as _, Oopsie, SpanTrace};

// ---- Enum: container keywords (module, suffix, size, path, vis) plus every
// ---- variant- and field-level keyword across its variants.

#[derive(Debug, Oopsie)]
#[oopsie(module(kitchen_sink))]
#[oopsie(suffix = "Ctx")]
#[oopsie(size(..=64))]
#[oopsie(path = "::oopsie")]
#[oopsie(vis(pub(crate)))]
enum KitchenSinkError {
    #[oopsie(
        display("formatted: {detail}"),
        help = "variant help",
        code = "kw::variant"
    )]
    #[oopsie(provide(::oopsie::HelpText => ::oopsie::HelpText::from_static("variant provide")))]
    #[oopsie(vis(pub(crate)))]
    Formatted { detail: String },

    #[oopsie(transparent)]
    Wrapped { source: io::Error },

    #[oopsie("from keyword: {inner}")]
    Marked {
        #[oopsie(from)]
        inner: io::Error,
    },

    #[oopsie("capture keyword")]
    Captured {
        #[oopsie(capture)]
        at: std::time::SystemTime,
    },

    #[oopsie("field provide keyword")]
    FieldProvide {
        #[oopsie(provide(::oopsie::HelpText => ::oopsie::HelpText::from(hint.clone())))]
        hint: String,
    },

    #[oopsie("split trace keywords")]
    SplitTraces {
        #[oopsie(backtrace)]
        bt: Box<Backtrace>,
        #[oopsie(spantrace)]
        st: Box<SpanTrace>,
    },

    #[oopsie("packed traces keyword")]
    Packed {
        #[oopsie(traces)]
        traces: Box<(Backtrace, SpanTrace)>,
    },

    #[oopsie("dynamic help keyword: {hint}")]
    DynamicHelp {
        #[oopsie(help)]
        hint: String,
    },

    #[oopsie("location keyword")]
    Located {
        #[oopsie(location)]
        at: &'static std::panic::Location<'static>,
    },
}

// ---- Struct: container and variant keywords mixed in one `#[oopsie(...)]`
// ---- scope, exercising the container-vs-variant routing, plus
// ---- `from(Type, transform)`.

#[derive(Debug, Oopsie)]
#[oopsie(module(struct_sink), suffix(false), size(..=64), path = "::oopsie", vis(pub(crate)))]
#[oopsie(display("struct: {name}"), help("try {name}"), code = "kw::struct")]
#[oopsie(provide(::oopsie::ErrorCode => ::oopsie::ErrorCode::from("kw::struct")))]
struct StructSinkError {
    name: String,
    #[oopsie(from(io::Error, Box::new))]
    cause: Box<io::Error>,
}

// ---- Attribute macro: every top-level argument (traced, path) and every
// ---- nested key (backtrace, spantrace, timestamp, packed, boxed, code,
// ---- chrono, provide, r#type, enabled) in their settings-list forms.

#[oopsie::oopsie(
    traced(
        backtrace(r#type = "::oopsie::Backtrace", boxed = true, enabled = true),
        spantrace(enabled = true),
        timestamp(chrono = false, provide = true, enabled = true),
        location = true,
        packed = false,
        boxed = true,
        code(r#type = ::oopsie::ErrorCode)
    ),
    path = "::oopsie"
)]
enum AttrSinkError {
    #[oopsie("attr sink: {info}")]
    Boom { info: String },
}

// ---- Attribute macro: the bool forms of the top-level arguments
// ---- (`debug = false` exercises the `attr::debug` doc target).

#[oopsie::oopsie(traced(code), debug = false)]
#[derive(Debug)]
enum AttrFlagError {
    #[oopsie("flag form")]
    Flagged,
}

#[test]
fn fixtures_construct() {
    let err = kitchen_sink::FormattedCtx {
        detail: "d".to_owned(),
    }
    .build();
    assert_eq!(err.to_string(), "formatted: d");

    let err: KitchenSinkError = io::Error::other("io").into();
    assert!(matches!(err, KitchenSinkError::Wrapped { .. }));

    let err = struct_sink::StructSink {
        name: "n".to_owned(),
    }
    .build_error(io::Error::other("io"));
    assert_eq!(err.to_string(), "struct: n");

    let err = attr_sink_oopsies::Boom {
        info: "i".to_owned(),
    }
    .build();
    assert_eq!(err.to_string(), "attr sink: i");

    let err = attr_flag_oopsies::Flagged.build();
    assert_eq!(err.to_string(), "flag form");
}