Skip to content

Commit

Permalink
Remove incorrect TryFromBytes docs w.r.t unions (#1259)
Browse files Browse the repository at this point in the history
We do support deriving `TryFromBytes` on unions, and our
conservative assumptions of their validity match intuition.

Makes progress towards #5.
  • Loading branch information
jswrenn authored May 14, 2024
1 parent 6286c3e commit d2e6bb8
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1036,9 +1036,7 @@ pub use zerocopy_derive::TryFromBytes;
///
/// For most use cases, Rust's current guarantees align with programmers'
/// intuitions about what ought to be valid. As a result, zerocopy's
/// conservatism should not affect most users. One notable exception is unions,
/// whose bit validity is very up in the air; zerocopy does not permit
/// implementing `TryFromBytes` for any union type.
/// conservatism should not affect most users.
///
/// If you are negatively affected by lack of support for a particular type,
/// we encourage you to let us know by [filing an issue][github-repo].
Expand Down

0 comments on commit d2e6bb8

Please sign in to comment.