Document TryFromBytes
#974
Merged
Conversation
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
jswrenn
force-pushed
the
doc-tryfrombytes
branch
from
a67df38 to
3460831
Compare
joshlf
requested changes
Feb 29, 2024
src/lib.rs
Outdated
| /// | ||
| /// WARNING: Do not implement this trait yourself! Instead, use | ||
| /// `#[derive(TryFromBytes)]`. | ||
| /// This derive synthesizes the runtime checks required to check if a sequence |
Member
There was a problem hiding this comment.
Suggested change
| /// This derive synthesizes the runtime checks required to check if a sequence | |
| /// This derive synthesizes the runtime checks required to check whether a sequence |
src/lib.rs
Outdated
| /// Types for which some bit patterns are valid. | ||
| /// | ||
| /// A memory region of the appropriate length which contains initialized bytes | ||
| /// can be viewed as a `TryFromBytes` type so long as the runtime value of bytes |
Member
There was a problem hiding this comment.
Suggested change
| /// can be viewed as a `TryFromBytes` type so long as the runtime value of bytes | |
| /// can be viewed as a `TryFromBytes` type so long as the runtime value of those bytes |
src/lib.rs
Outdated
| /// A memory region of the appropriate length which contains initialized bytes | ||
| /// can be viewed as a `TryFromBytes` type so long as the runtime value of bytes | ||
| /// correspond to a [*valid instance*] of that type. For example, [`bool`] is | ||
| /// `TryFromBytes`; zerocopy can transmute a [`bool`] into a [`u8`] so long as |
Member
There was a problem hiding this comment.
Suggested change
| /// `TryFromBytes`; zerocopy can transmute a [`bool`] into a [`u8`] so long as | |
| /// `TryFromBytes`; zerocopy can transmute a [`u8`] into a [`bool`] so long as |
Also, this isn't technically true in our API (right now). We don't have try_transmute!, so we can't actually do this. Maybe say something like "zerocopy can transmute a [u8] into a bool..."?
jswrenn
force-pushed
the
doc-tryfrombytes
branch
from
3460831 to
15e6e02
Compare
Makes progress towards #5.
jswrenn
force-pushed
the
doc-tryfrombytes
branch
from
15e6e02 to
611361c
Compare
joshlf
approved these changes
Feb 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Makes progress towards #5.