Skip to content

Commit 6958627

Browse files
committed
Improve FromBytes documentation and release 0.7.27
This PR adds examples to most methods of `FromBytes`, and separately documents `derive(FromBytes)`. Theoretical soundness requirements are placed with trait documentation, and the details of the derive's analysis is placed in the derive documentation. This PR follows the pattern of #505. Makes progress towards #32.
1 parent 40202e4 commit 6958627

File tree

3 files changed

+598
-55
lines changed

3 files changed

+598
-55
lines changed

Cargo.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
[package]
1616
edition = "2018"
1717
name = "zerocopy"
18-
version = "0.7.26"
18+
version = "0.7.27"
1919
authors = ["Joshua Liebow-Feeser <[email protected]>"]
2020
description = "Utilities for zero-copy parsing and serialization"
2121
license = "BSD-2-Clause OR Apache-2.0 OR MIT"
@@ -49,7 +49,7 @@ simd-nightly = ["simd"]
4949
__internal_use_only_features_that_work_on_stable = ["alloc", "derive", "simd"]
5050

5151
[dependencies]
52-
zerocopy-derive = { version = "=0.7.26", path = "zerocopy-derive", optional = true }
52+
zerocopy-derive = { version = "=0.7.27", path = "zerocopy-derive", optional = true }
5353

5454
[dependencies.byteorder]
5555
version = "1.3"
@@ -60,7 +60,7 @@ optional = true
6060
# zerocopy-derive remain equal, even if the 'derive' feature isn't used.
6161
# See: https://github.com/matklad/macro-dep-test
6262
[target.'cfg(any())'.dependencies]
63-
zerocopy-derive = { version = "=0.7.26", path = "zerocopy-derive" }
63+
zerocopy-derive = { version = "=0.7.27", path = "zerocopy-derive" }
6464

6565
[dev-dependencies]
6666
assert_matches = "1.5"
@@ -75,6 +75,6 @@ testutil = { path = "testutil" }
7575
# CI test failures.
7676
trybuild = { version = "=1.0.85", features = ["diff"] }
7777
# In tests, unlike in production, zerocopy-derive is not optional
78-
zerocopy-derive = { version = "=0.7.26", path = "zerocopy-derive" }
78+
zerocopy-derive = { version = "=0.7.27", path = "zerocopy-derive" }
7979
# TODO(#381) Remove this dependency once we have our own layout gadgets.
8080
elain = "0.3.0"

0 commit comments

Comments
 (0)