Improve Result's Display impl for extension values #424
Conversation
This file contains 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
theo3
force-pushed
the
master
branch
2 times, most recently
from
cc37e66
to
538fecf
Compare
MarijnS95
approved these changes
Apr 27, 2021
There was a problem hiding this comment.
Yeah, that's a much smarter way to go about this! Would you mind adding a comment clarifying that this forwards the call to the Debug printer generated for all enum variants in const_debugs.rs? Thanks!
(And indeed, if that printer doesn't know the enum variant either it'll finally fall back to self.0.fmt(fmt) again 👍 )
MarijnS95
reviewed
Apr 27, 2021
MarijnS95
added a commit
that referenced
this pull request
Apr 27, 2021
The docs clearly state:
#[rustc_deprecated(since = "1.42.0", reason = "use the Display impl or to_string()")]
fn description(&self) -> &str {
"description() is deprecated; use Display"
}
We already have a `Display` implementation containing an identical
`match` block and has further improvements on the way in [1].
[1]: #424
Previously, the `Display` impl for `vk::Result` did not include handling for extension values. For example, VK_ERROR_OUT_OF_DATE_KHR would display simply as "-1000001004". Now, we fall back to the `Debug` impl of the `Result` if the value is unknown (i.e. from an extension). This preserves the current nice messages for non-extension values, and the numeric output for truly unknown values, but displays the enum variant name (e.g. "ERROR_OUT_OF_DATE") for extension values.
|
@theo3 Awesome, thanks! Merging as soon as the CI succeeds. |
MarijnS95
added a commit
that referenced
this pull request
Apr 27, 2021
The docs clearly state:
#[rustc_deprecated(since = "1.42.0", reason = "use the Display impl or to_string()")]
fn description(&self) -> &str {
"description() is deprecated; use Display"
}
We already have a `Display` implementation containing an identical
`match` block and has further improvements on the way in [1].
[1]: #424
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously, the
Displayimpl forvk::Resultdid not include handling for extension values. For example, VK_ERROR_OUT_OF_DATE_KHR would display simply as "-1000001004".With this change, we fall back to the
Debugimpl of theResultif the value is unknown (i.e. from an extension). This preserves the current nice messages for non-extension values, and the numeric output for truly unknown values, but displays the enum variant name (e.g. "ERROR_OUT_OF_DATE_KHR") for extension-provided enum variants.