Add examples to hex iterator constructors#241
Merged
apoelstra merged 1 commit intorust-bitcoin:masterfrom Apr 21, 2026
Merged
Conversation
The hex -> bytes iterators in the iter module are visible in the public api but don't have any code examples attached to them. While they're reasonably self-explanatory, some short example snippets on the constructors should make sure that it's absolutely unambiguous how they're to be used. Add example to HexSliceToBytesIter::new and HexBytesToIter::from_pairs.
bb07974 to
2e9594a
Compare
tcharding
approved these changes
Apr 20, 2026
Member
|
The two lines of /// ```
/// # #[cfg(feature = "std")] {
/// # use hex_conservative::HexToBytesIter;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
///
/// let hex_digits: Vec<u8> = b"deadbeef".iter().copied().collect();
/// let pairs = hex_digits.chunks_exact(2).map(|c| [c[0], c[1]]);
///
/// let decoded: = HexToBytesIter::from_pairs(pairs).collect::<Result<_, _>>()?;
/// assert_eq!(decoded, [0xde, 0xad, 0xbe, 0xef]);
///
/// # Ok(()) }}
/// ```
|
Member
|
Oh my version renders poorly because of the new lines. Please ignore. |
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
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.
The hex -> bytes iterators in the iter module are visible in the public api but don't have any code examples attached to them. While they're reasonably self-explanatory, some short example snippets on the constructors should make sure that it's absolutely unambiguous how they're to be used.
Add example to HexSliceToBytesIter::new and HexBytesToIter::from_pairs.