feat: make it clear when an invalid instance is created #8
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
DaniPopes
force-pushed
the
dani/clarify-validity
branch
from
61981e4
to
8166c42
Compare
kirk-baird
reviewed
Feb 26, 2024
| /// # Internal representation | ||
| /// | ||
| /// The internal representation is currently a [`SmallVec`] that stores one nibble per byte. Nibbles | ||
| /// are stored inline (on the stack) up to a length of 64 nibbles, or 32 unpacked bytes. This means |
There was a problem hiding this comment.
Bit of a nit pick but I think this should be "32 packed bytes" rather than "32 unpacked bytes"
kirk-baird
reviewed
Feb 26, 2024
| /// ``` | ||
| #[inline] | ||
| #[track_caller] | ||
| pub fn from_nibbles<T: AsRef<[u8]>>(bytes: T) -> Self { |
There was a problem hiding this comment.
For the checked versions I would encourage using an Error rather than panicking on invalid nibbles.
e.g. for the following functions if any single bytes is > 0x0f
from_nibbles()from_vec()
Although not strictly necessary this could be helpful for users decoding data from untrusted input, such that they don't need to validate the nibbles themselves. If they have validated the bytes they can use the unchecked() versions.
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.
From<Vec<u8>>impl in favor offrom_vec_uncheckedmethodExtendimpl in favor ofextend_from*methodsSmallVec_uncheckedthat check validity of nibbles, and viceversa add missing checks and unchecked versions