-
Notifications
You must be signed in to change notification settings - Fork 114
Add section about not including sources in Display impl #210
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.
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
Open
faern
wants to merge
1
commit into
rust-lang:master
Choose a base branch
from
faern:errors-display-vs-source
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -272,7 +272,27 @@ be lowercase without trailing punctuation, and typically concise. | |
[`Error::description()`] should not be implemented. It has been deprecated and users should | ||
always use `Display` instead of `description()` to print the error. | ||
|
||
If an error type returns an underlying source error from [`Error::source()`], it does **not** | ||
include that source error in its own `Display` representation as well. This avoids duplicated | ||
information when an error is printed along with all its sources: | ||
|
||
```rust | ||
use std::fmt; | ||
|
||
impl fmt::Display for ParseError { | ||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
// Good errors never duplicate information like this: | ||
write!(f, "failed to parse: {}", self.source), | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. that doesn't work due to the trailing |
||
|
||
// Instead they just describe themselves: | ||
write!(f, "failed to parse"), | ||
} | ||
} | ||
``` | ||
|
||
[`Error::description()`]: https://doc.rust-lang.org/std/error/trait.Error.html#tymethod.description | ||
[`Error::source()`]: https://doc.rust-lang.org/std/error/trait.Error.html#method.source | ||
|
||
|
||
### Examples from the standard library | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'm aware that the existing example already does the good/bad thing, but it might be better to just show the "good" thing? but then make it a full-fledged example (i.e. also include the
impl std::error::Error for ParseError
withfn source
implemented?