TimelyDataflow / abomonation

A mortifying serialization library for Rust
MIT License
322 stars 30 forks source link

[Based on #24] Document the unsafety a bit more #25

Open HadrienG2 opened 5 years ago

HadrienG2 commented 5 years ago

In the continuity of #19, this PR tries to document why decode can't just return an &mut to the deserialized data, and why internal mutability is dangerous in an Abomonation context, by narrowing down a little bit which types are abomonable and which aren't.

Along the way, I also made the Abomonation trait 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 .