Add Debug Implementations to Remaining Public Types #218
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
There were some types that could not derive Debug automatically in gfx-rs#216 because they (or types they transitively contained) contained types from external crates that do not implement Debug. By adding custom Debug impls, we can handle this case. The Debug impls given here do the same thing #[derive(Debug)] would do, except that they skip the fields that do not themselves implement Debug. After this, all public types will implement Debug, as requested in gfx-rs#76.
kvark
reviewed
Jun 9, 2019
| @@ -518,6 +527,23 @@ impl Device<back::Backend> { | |||
| } | |||
| } | |||
|
|
|||
| impl<B: hal::Backend> fmt::Debug for Device<B> { | |||
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |||
There was a problem hiding this comment.
is the queue group the only thing that isn't Debug? We might want an easier way to solve this
| impl fmt::Debug for Hub { | ||
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | ||
| f.debug_struct("Hub") | ||
| .field("surfaces", &self.surfaces) |
There was a problem hiding this comment.
is instances the only thing that isn't Debug?
There was a problem hiding this comment.
No, it's also adapters.
| .field("device_id", &self.device_id) | ||
| .field("desc", &self.desc) | ||
| .field("acquired", &self.acquired) | ||
| .field("sem_available", &self.sem_available) |
There was a problem hiding this comment.
is command pool the only thing that isn't Debug?
There was a problem hiding this comment.
No, it's also frames.
|
In each struct, there are only one or two fields that are incompatible with
Do you have any other ideas? |
|
I strongly prefer (1)
… On Jun 10, 2019, at 05:11, John W. Bruce ***@***.***> wrote:
In each struct, there are only one or two fields that are incompatible with Debug. Unfortunately, it's not possible to #[derive(Debug) except for this one field] in the standard library. The two alternatives that I've thought of:
Submit changes to the upstream crates to implement Debug for these types, then wait for releases so we can update wgpu's types. They're public types of those crates, so they should really implement Debug anyway.
Derivative contains macros that allow code to omit fields from #[derive(Debug)], but I don't know if you want to take on a dependency.
Do you have any other ideas?
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
OK. I'll start tracking all these types down throughout the gfx crate family and get back to you. |
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.
There were some types that could not derive
Debugautomatically in #216 because they (or types they transitively contained) contained types from external crates that do not implementDebug. By adding customDebugimpls, we can handle this case. The Debug impls given here do the same thing#[derive(Debug)]would do, except that they skip the fields that do not themselves implementDebug.After this, all public types will implement
Debug, as requested in #76.Closes #76