[Based on #24] Document the unsafety a bit more #25
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
HadrienG2
force-pushed
the
unsafe-docs
branch
2 times, most recently
from
c389ead
to
9d4f8a7
Compare
HadrienG2
force-pushed
the
unsafe-docs
branch
from
9d4f8a7
to
3130ba1
Compare
By its very nature, Abomonation does very unsafe (and UB-ish) things. But we should strive to explain these as well as we can in the current state of the unsafe Rust formalization effort in order to reduce the potential for known misuse.
HadrienG2
force-pushed
the
unsafe-docs
branch
from
3130ba1
to
ee283b0
Compare
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.
In the continuity of #19, this PR tries to document why
decodecan't just return an&mutto the deserialized data, and why internal mutability is dangerous in anAbomonationcontext, by narrowing down a little bit which types are abomonable and which aren't.Along the way, I also made the
Abomonationtrait unsafe, because I believe that implementing the trait is unsafe in the sense that an implementation must match certain preconditions in order to avoid triggering UB from downstream unsafe code that uses abomonation.For convenience reasons, this PR is based on #22 and #24, so reviewing those first is recommended. If you want to review this PR now, please do so commit-wise.
Fixes #19 .