Skip to content

Commit 82de879

Browse files
committed
Refresh implemented roadmap status
1 parent 56a5a70 commit 82de879

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@
66
- Added strict standard and URL-safe Base64 engines.
77
- Added caller-owned encode/decode buffers and in-place decode.
88
- Added in-place encoding.
9-
- Added optional `alloc` vector helpers.
9+
- Added stable compile-time encoding into caller-sized arrays.
10+
- Added optional `alloc` vector and encoded string helpers.
1011
- Added `std::io::Write` and `std::io::Read` streaming encoders behind the `stream` feature.
1112
- Added `std::io::Write` streaming decoder behind the `stream` feature.
1213
- Added `std::io::Read` streaming decoder behind the `stream` feature.
1314
- Added checked encoded-length helpers.
1415
- Added exact decoded-length helpers.
1516
- Hardened decode errors to report absolute input indexes.
17+
- Added Miri support in CI and the local release gate when installed.
1618
- Added project plan, security policy, local gates, CI, dependency policy, SBOM script, and reproducible build script.

docs/PLAN.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Build `base64-ng` as a modern, secure, `no_std`-first Base64 implementation for
1212
- License: `MIT OR Apache-2.0`.
1313
- Project name: `base64-ng`.
1414
- Runtime and dev dependency graph: zero external crates.
15-
- Local testing system modeled after `fluxheim`: check script, release gate, dependency policy, audit config, SBOM, reproducible build check, and CI.
15+
- Local testing system modeled after `fluxheim`: check script, release gate, dependency policy, audit config, Miri when installed, SBOM, reproducible build check, and CI.
1616

1717
## Dependency Policy
1818

@@ -66,7 +66,8 @@ Any dependency addition must answer:
6666
- No unsafe code.
6767

6868
2. `alloc`
69-
- Future `Vec<u8>` and `String` helpers.
69+
- `Vec<u8>` decode/encode helpers.
70+
- Encoded `String` helper.
7071
- Optional feature.
7172

7273
3. `simd`
@@ -76,7 +77,7 @@ Any dependency addition must answer:
7677
- Unsafe isolated and documented.
7778

7879
4. `stream`
79-
- Future `std::io::{Read, Write}` wrappers.
80+
- `std::io::{Read, Write}` wrappers.
8081
- Chunk-boundary state machines.
8182

8283
5. `tokio`
@@ -135,15 +136,18 @@ Phase 3:
135136
- Standard and URL-safe alphabets.
136137
- Padded and unpadded modes.
137138
- Caller-owned output buffers.
139+
- Stable compile-time encoding into caller-sized arrays.
140+
- `alloc` `Vec<u8>` and encoded `String` helpers.
141+
- `std::io` streaming wrappers.
142+
- Miri integrated into CI and the local release gate when installed.
143+
- In-place encoding.
138144
- In-place decoding.
139145
- Hardened test/release scripts.
140146

141147
### v0.2
142148

143-
- `alloc` convenience APIs.
144149
- Explicit legacy decode mode.
145150
- More exhaustive malformed-input tests.
146-
- Miri integration.
147151

148152
### v0.3
149153

@@ -160,10 +164,6 @@ Phase 3:
160164

161165
### v0.5
162166

163-
- Broader chunk-boundary state machine tests.
164-
165-
### v0.6
166-
167167
- Tokio streaming wrappers.
168168
- Async cancellation and partial-read tests.
169169

0 commit comments

Comments
 (0)