Module guide

Source
Available on crate feature guide only.
Expand description

§SNAFU user’s guide

Looking for quick help or answers? Please see the troubleshooting page.


Once you’ve got a high-level idea of what SNAFU can do by looking at the quick example and some more examples, take a peek at our design philosophy.

For more advanced usage, take a deeper dive into what the Snafu macro generates, how to create opaque error types, how to create error structs, and how to use generic types and lifetimes.

For optional features of the crate, see our list of feature flags.

If you are targeting an older release of Rust, you will be interested in the compatibility section.

For upgrading from a previous version, review the upgrading guide.

For comparisons and migration tips from another error library, see the comparison list.

Modules§

comparison
Comparisons to similar libraries
compatibility
Rust version compatibility
examples
Examples of using SNAFU
feature_flags
Optional extensions to the crate
generics
Using generic types
opaque
How to create opaque error types for public APIs
philosophy
SNAFU’s design philosophy
structs
Struct errors
troubleshooting
Troubleshooting common issues
upgrading
Upgrading from previous releases
what_code_is_generated
What code is generated by the Snafu macro