Merge pull request #454 from shepmaster/maint

Maintenance
shepmaster · May 24, 2024 · 36c6bbe · 36c6bbe
2 parents 117aeee + 26b8204
commit 36c6bbe
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 11 deletions.
diff --git a/compatibility-tests/compile-fail/tests/ui/report.stderr b/compatibility-tests/compile-fail/tests/ui/report.stderr
@@ -21,3 +21,23 @@ error[E0277]: the trait bound `ExitCode: __InternalExtractErrorType` is not sati
   |
   = help: the trait `__InternalExtractErrorType` is implemented for `Result<T, E>`
   = note: this error originates in the attribute macro `snafu::report` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0277]: the trait bound `snafu::Report<_>: From<()>` is not satisfied
+ --> tests/ui/report.rs:6:1
+  |
+6 | #[snafu::report]
+  | ^^^^^^^^^^^^^^^^ the trait `From<()>` is not implemented for `snafu::Report<_>`
+  |
+  = help: the trait `From<Result<(), _>>` is implemented for `snafu::Report<_>`
+  = help: for that trait implementation, expected `Result<(), _>`, found `()`
+  = note: this error originates in the attribute macro `snafu::report` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0277]: the trait bound `snafu::Report<_>: From<ExitCode>` is not satisfied
+ --> tests/ui/report.rs:9:1
+  |
+9 | #[snafu::report]
+  | ^^^^^^^^^^^^^^^^ the trait `From<ExitCode>` is not implemented for `snafu::Report<_>`
+  |
+  = help: the trait `From<Result<(), _>>` is implemented for `snafu::Report<_>`
+  = help: for that trait implementation, expected `Result<(), _>`, found `ExitCode`
+  = note: this error originates in the attribute macro `snafu::report` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/compatibility-tests/renamed-import/src/lib.rs b/compatibility-tests/renamed-import/src/lib.rs
@@ -5,8 +5,8 @@ use a_rose::{Backtrace, Snafu};
 #[derive(Debug, Snafu)]
 #[snafu(crate_root(a_rose))]
 enum EnumError {
-    Leaf { username: String },
-    WithBacktrace { backtrace: Backtrace },
+    _Leaf { username: String },
+    _WithBacktrace { backtrace: Backtrace },
 }
 
 #[derive(Debug, Snafu)]

diff --git a/src/Snafu.md b/src/Snafu.md
@@ -46,15 +46,15 @@ it is valid. Detailed information on each attribute is below.
 
 ### Context fields
 
-| Option (inside `#[snafu(...)]`) | Description                                                                                               |
-|---------------------------------|-----------------------------------------------------------------------------------------------------------|
-| `source`                        | Marks a field as the source error (even if not called `source`)                                           |
-| `source(from(type, transform))` | As above, plus converting from `type` to the field type by calling `transform`                            |
-| `source(false)`                 | Marks a field that is named `source` as a regular field                                                   |
-| `backtrace`                     | Marks a field as backtrace (even if not called `backtrace`)                                               |
-| `backtrace(false)`              | Marks a field that is named `backtrace` as a regular field                                                |
-| `implicit`                      | Marks a field as implicit (Type needs to implement [`GenerateImplicitData`](crate::GenerateImplicitData)) |
-| `provide`                       | Marks a field as providing a reference to the type                                                        |
+| Option (inside `#[snafu(...)]`) | Description                                                                    |
+|---------------------------------|--------------------------------------------------------------------------------|
+| `source`                        | Marks a field as the source error (even if not called `source`)                |
+| `source(from(type, transform))` | As above, plus converting from `type` to the field type by calling `transform` |
+| `source(false)`                 | Marks a field that is named `source` as a regular field                        |
+| `backtrace`                     | Marks a field as backtrace (even if not called `backtrace`)                    |
+| `backtrace(false)`              | Marks a field that is named `backtrace` as a regular field                     |
+| `implicit`                      | Marks a field as implicit (Type needs to implement [`GenerateImplicitData`][]) |
+| `provide`                       | Marks a field as providing a reference to the type                             |
 
 ## Controlling `Display`