Skip to content

Fix error chapter with regards to deprecated description() and cause() #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 5, 2020
Merged

Fix error chapter with regards to deprecated description() and cause() #209

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86cbdfc
Refer to Error::source() instead of deprecated cause()
faern Jan 5, 2020
c44f833
Say that Error::description is deprecated and should not be implemented
faern Jan 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/interoperability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,11 @@ An error type is any type `E` used in a `Result<T, E>` returned by any public
function of your crate. Error types should always implement the
[`std::error::Error`] trait which is the mechanism by which error handling
libraries like [`error-chain`] abstract over different types of errors, and
which allows the error to be used as the [`cause()`] of another error.
which allows the error to be used as the [`source()`] of another error.

[`std::error::Error`]: https://doc.rust-lang.org/std/error/trait.Error.html
[`error-chain`]: https://docs.rs/error-chain
[`cause()`]: https://doc.rust-lang.org/std/error/trait.Error.html#method.cause
[`source()`]: https://doc.rust-lang.org/std/error/trait.Error.html#method.source

Additionally, error types should implement the [`Send`] and [`Sync`] traits. An
error that is not `Send` cannot be returned by a thread run with
Expand Down Expand Up @@ -269,9 +269,8 @@ impl Error for DoError { /* ... */ }
The error message given by the `Display` representation of an error type should
be lowercase without trailing punctuation, and typically concise.

The message given by [`Error::description()`] does not matter. Users should
always use `Display` instead of `description()` to print the error. A low-effort
description like `"JSON error"` is sufficient.
[`Error::description()`] should not be implemented. It has been deprecated and users should
always use `Display` instead of `description()` to print the error.

[`Error::description()`]: https://doc.rust-lang.org/std/error/trait.Error.html#tymethod.description

Expand Down