mirrors/thiserror
1
0
Fork 0
mirror of https://github.com/dtolnay/thiserror.git synced 2025-04-04 13:27:38 +03:00
Code Issues Projects Releases Packages Wiki Activity

Fix documentation mentioning 'backtrace()' method

Browse source
This commit is contained in:
David Tolnay 2022-09-27 14:34:19 -07:00
parent 7b226e33c7
commit c2759ce82e
No known key found for this signature in database
GPG key ID: F9BA143B95FF6D82
2 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -124,8 +124,8 @@ pub enum DataStoreError {
} }
``` ```
- The Error trait's `backtrace()` method is implemented to return whichever - The Error trait's `provide()` method is implemented to provide whichever field
field has a type named `Backtrace`, if any. has a type named `Backtrace`, if any, as a `std::backtrace::Backtrace`.
```rust ```rust
use std::backtrace::Backtrace; use std::backtrace::Backtrace;
@ -138,8 +138,9 @@ pub enum DataStoreError {
``` ```
- If a field is both a source (named `source`, or has `#[source]` or `#[from]` - If a field is both a source (named `source`, or has `#[source]` or `#[from]`
attribute) *and* is marked `#[backtrace]`, then the Error trait's attribute) *and* is marked `#[backtrace]`, then the Error trait's `provide()`
`backtrace()` method is forwarded to the source's backtrace. method is forwarded to the source's `provide` so that both layers of the error
share the same backtrace.
```rust ```rust
#[derive(Error, Debug)] #[derive(Error, Debug)]

8
src/lib.rs
View file

@ -146,8 +146,9 @@
//! # } //! # }
//! ``` //! ```
//! //!
//! - The Error trait's `backtrace()` method is implemented to return whichever //! - The Error trait's `provide()` method is implemented to provide whichever
//! field has a type named `Backtrace`, if any. //! field has a type named `Backtrace`, if any, as a
//! `std::backtrace::Backtrace`.
//! //!
//! ```rust //! ```rust
//! # const IGNORE: &str = stringify! { //! # const IGNORE: &str = stringify! {
@ -163,7 +164,8 @@
//! //!
//! - If a field is both a source (named `source`, or has `#[source]` or //! - If a field is both a source (named `source`, or has `#[source]` or
//! `#[from]` attribute) *and* is marked `#[backtrace]`, then the Error //! `#[from]` attribute) *and* is marked `#[backtrace]`, then the Error
//! trait's `backtrace()` method is forwarded to the source's backtrace. //! trait's `provide()` method is forwarded to the source's `provide` so that
//! both layers of the error share the same backtrace.
//! //!
//! ```rust //! ```rust
//! # const IGNORE: &str = stringify! { //! # const IGNORE: &str = stringify! {