Add Debug trait implementation for ReadOnly, WriteOnly, and Volatile #126
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
qwandor
reviewed
Apr 22, 2024
| @@ -104,5 +122,7 @@ macro_rules! volwrite { | |||
| }; | |||
| } | |||
|
|
|||
| use core::fmt::{Debug, Formatter}; | |||
There was a problem hiding this comment.
Put these imports at the top of the file.
| @@ -3,6 +3,12 @@ | |||
| #[repr(transparent)] | |||
| pub struct ReadOnly<T: Copy>(T); | |||
|
|
|||
| impl<T: Debug + Copy> Debug for ReadOnly<T> { | |||
| fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { | |||
There was a problem hiding this comment.
No need for the explicit lifetime <'_> here and in the other implementation below.
| @@ -15,6 +21,12 @@ impl<T: Copy> ReadOnly<T> { | |||
| #[repr(transparent)] | |||
| pub struct WriteOnly<T: Copy>(T); | |||
|
|
|||
| impl<T: Debug + Copy> Debug for WriteOnly<T> { | |||
| fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { | |||
| f.debug_tuple("WriteOnly").field(&self.0).finish() | |||
There was a problem hiding this comment.
WriteOnly is used to wrap MMIO registers which can only be written, so it doesn't make sense to read a value from it.
| @@ -3,6 +3,12 @@ | |||
| #[repr(transparent)] | |||
| pub struct ReadOnly<T: Copy>(T); | |||
|
|
|||
| impl<T: Debug + Copy> Debug for ReadOnly<T> { | |||
| fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { | |||
| f.debug_tuple("ReadOnly").field(&self.0).finish() | |||
There was a problem hiding this comment.
ReadOnly is intended to wrap MMIO registers which may have side-effects when reading, so it's probably not a good idea to implement Debug, as adding debug output may change behaviour. Also any reading should be done with read_volatile.
There was a problem hiding this comment.
Indeed, you are right, I didn't consider the issue of side effects.
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.
No description provided.