wire-codec 1.0.0

Binary frame codec and protocol codec toolkit. Length-prefixed, delimiter-based, and custom framing strategies. Built-in varint, zigzag, bitfield, and packed struct encoding. Runtime-agnostic foundation under network-protocol crates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

# Changelog

All notable changes to `wire-codec` will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

---

## [Unreleased]

### Added

### Changed

### Fixed

### Security

---

## [1.0.0] - 2026-05-21

### Added

- Substantially expanded `README.md`: design rationale section, feature
  list, four usage patterns (length-prefixed, delimited, varint + zigzag,
  bit-packed records), reference performance table, stability statement,
  feature-flag table, and project layout diagram.
- Cookbook section in `docs/API.md` with four recipes: append-only stream
  over a growing buffer, fixed-output buffer with `BufferFull`
  back-pressure, length-prefixed envelope around a structured record, and
  pre-sized-output hot-loop pattern.
- Stability note in `docs/API.md` introducing the 1.0 freeze contract.
- Crate-level rustdoc in `src/lib.rs` rewritten with a "When to reach for
  this crate" section, module map table, stability section, and feature
  flag table.
- `docs/release/v1.0.0.md` with the locked benchmark baseline.

### Changed

- `README.md` corrects the edition claim (`2024` -> `2021`) and bumps the
  dependency version pin to `"1"`.
- `docs/API.md` `VERSION` reference updated to `"1.0.0"`.

### Stability

- Public API surface is now frozen. Subsequent `1.x` releases will be
  additive: new `Error` variants, new `LengthWidth` variants, new methods
  on existing types, new feature flags. Any breaking change requires a
  `2.0` release.

---

## [0.9.0] - 2026-05-21

### Added

- `Error::EmptyDelimiter` variant returned by `Delimited::new` when the
  delimiter is empty.
- `#[non_exhaustive]` on `LengthWidth` so wider prefix widths can be added
  in future minor releases.
- `PartialEq`, `Eq`, `Hash` derives on `LengthPrefixed`, `Delimited`,
  `LengthWidth`, and `Endian`.
- `#[must_use]` on `Encode::encoded_size`.
- `# Errors` doc sections on every `Result`-returning function in
  `buf`, `varint`, `bitfield`, and `framing`.
- `rust-toolchain.toml` pinning the toolchain channel for reproducible
  builds.
- `deny.toml` policy file for `cargo deny` (license allow-list, banned
  crates, duplicate version warning, registry source restriction).
- `supply-chain` CI job running `cargo audit` and `cargo deny check` on
  every push and pull request.
- Canonical `REPS.md` vendored from the workspace standard.
- `docs/release/v0.9.0.md` audit report covering every section of REPS.

### Changed

- **Breaking:** `framing::Delimited::new(delimiter)` now returns
  `Result<Delimited<'_>, Error>` instead of `Self`. An empty delimiter
  yields `Err(Error::EmptyDelimiter)` rather than panicking. Update call
  sites with `.unwrap()` or `?` as appropriate.
- Crate-level lint set expanded to the REPS-mandated full configuration
  (`#![deny(warnings)]`, `#![deny(clippy::unreachable)]`).

### Fixed

- `Delimited::new` no longer panics on empty input. This was the only
  panic point in the shipping code paths.

### Security

- `cargo audit` and `cargo deny` are now part of CI. Any RustSec
  advisory, banned crate, or license violation in the dependency tree
  blocks the merge.

---

## [0.5.0] - 2026-05-21

### Added

- Property-test suite (`proptest`) covering varint round-trip, zigzag inverse,
  framer round-trip, bitfield round-trip, and panic-freedom on arbitrary byte
  input.
- Integration test suite (`tests/integration_protocols.rs`) covering:
  partial-delivery length-prefixed streams, newline-delimited line protocols,
  HTTP-style CR/LF request parsing, two-layer length-prefixed + varint record
  pipelines, and back-pressure semantics.
- Bench harness with zero-dependency manual timing (`benches/codec.rs`,
  `benches/framing.rs`). Reports nanoseconds per operation for the varint,
  zigzag, buffer, and framing primitives.
- Three runnable examples under `examples/`: `length_prefixed_echo`,
  `newline_protocol`, `varint_record`.
- `proptest = ">=1, <1.6"` as a dev-dependency (capped below 1.6 so the
  `cargo test` build resolves on MSRV 1.75).
- `.github` CI cache step updated to `actions/cache@v5` to retire the Node 20
  deprecation warning.
- `.gitattributes` pinning all text files to LF on checkout, so Windows CI
  matches `rustfmt.toml`'s `newline_style = "Unix"`.

### Changed

- Documentation surface is unchanged; existing rustdoc covered the new
  invariants without revision.

### Fixed

- `clippy.toml`: removed `allow-panic-in-tests`, `allow-dbg-in-tests`, and
  `allow-print-in-tests` (added after MSRV 1.75); kept the two pre-1.75
  options (`allow-unwrap-in-tests`, `allow-expect-in-tests`).
- `varint::encoded_len_*` allow attributes now use
  `#[allow(unknown_lints, clippy::manual_div_ceil)]` so older clippy releases
  silently skip the unknown lint instead of failing.

---

## [0.2.0] - 2026-05-21

### Added

- Public error type `Error` with `Result<T>` alias.
- Zero-copy cursor primitives `ReadBuf` and `WriteBuf` for borrowed byte slices.
- Codec trait pair `Encode` and `Decode<'de>` with a blanket impl for `u8`.
- LEB128 unsigned varint module (`varint::{encode_u32, encode_u64, decode_u32, decode_u64, encoded_len_u32, encoded_len_u64, MAX_LEN_U16, MAX_LEN_U32, MAX_LEN_U64}`).
- Zigzag signed-integer module (`zigzag::{encode_i32, decode_i32, encode_i64, decode_i64}`), all `const fn`.
- Packed-bit cursors `BitReader` and `BitWriter`, big-endian (MSB-first) bit order.
- Framing module with `Framer` trait, `Frame<'a>` envelope, `LengthPrefixed`
  (u8 / u16 / u32 width, big or little endian), and `Delimited` (single or
  multi-byte delimiter).
- End-to-end smoke test exercising encode + framing + decode in one pipeline.
- API reference at `docs/API.md`.
- Release note at `docs/release/v0.2.0.md`.

### Changed

- Edition lowered from 2024 to 2021 to match the declared MSRV of 1.75.

---

## [0.1.0] - 2026-05-18

### Added

- Initial scaffold and repository bootstrap.
- REPS compliance baseline.
- CI for Linux/macOS/Windows on stable and MSRV (1.75).

[Unreleased]: https://github.com/jamesgober/wire-codec/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/jamesgober/wire-codec/compare/v0.9.0...v1.0.0
[0.9.0]: https://github.com/jamesgober/wire-codec/compare/v0.5.0...v0.9.0
[0.5.0]: https://github.com/jamesgober/wire-codec/compare/v0.2.0...v0.5.0
[0.2.0]: https://github.com/jamesgober/wire-codec/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/jamesgober/wire-codec/releases/tag/v0.1.0