Module snafu::guide[][src]

SNAFU user’s guide

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 how the Snafu macro works, how to create opaque error types, how to create error structs, how to use generic types and lifetimes, and what attributes are available.

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

attributes

Attributes understood by the Snafu macro

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

the_macro

Details about the output of the Snafu macro

upgrading

Upgrading from previous releases