Document and test HexWriter constructor
#144
Merged
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
54 tasks
|
rustfmt is unhappy with this |
|
Why do you idiots even use the formatter in CI ... oh wait |
Thanks to a blanket impl of `Write` for `&mut W` we can pass in a mutable reference to `HexWriter::new` even though the function signature suggests it takes ownership of the writer. Document this as suggested in the Rust API guidelines doc. While we are at it add a unit test to prove it. ref: https://rust-lang.github.io/api-guidelines/interoperability.html#c-rw-value
tcharding
force-pushed
the
01-22-hex-writer
branch
from
fca1633 to
0f8d203
Compare
Kixunil
reviewed
Jan 23, 2025
| fn hex_writer_accepts_and_mut() { | ||
| let mut dest_buf = ArrayString::<64>::new(); | ||
| let mut dest = HexWriter::new(&mut dest_buf, Case::Lower); | ||
| let _got = dest.write(b"some data").unwrap(); |
There was a problem hiding this comment.
This test is actually testing that std still has the &mut T impl. I'm certain we don't need to test that. :)
There was a problem hiding this comment.
Correct. It also proves, probably unnecessarily like you say, that the docs I wrote in this PR are correct.
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.
Thanks to a blanket impl of
Writefor&mut Wwe can pass in a mutable reference toHexWriter::neweven though the function signature suggests it takes ownership of the writer.Document this as suggested in the Rust API guidelines doc.
While we are at it add a unit test to prove it.
ref: https://rust-lang.github.io/api-guidelines/interoperability.html#c-rw-value