Skip to content

Commit 290ba80

Browse files
committed
Clarify async companion status
1 parent 762675b commit 290ba80

3 files changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ license = "MIT OR Apache-2.0"
215215
| `stream` | no | `std::io` streaming wrappers. |
216216
| `allow-wasm32-best-effort-wipe` | no | Explicitly allow `wasm32` builds with compiler-fence-only cleanup. |
217217
| `allow-compiler-fence-only-wipe` | no | Explicitly allow unsupported native architectures to build with compiler-fence-only cleanup after platform review. |
218-
| `tokio` | no | Reserved for future async streaming wrappers; currently inert and dependency-free. |
218+
| `tokio` | no | Reserved placeholder in the core crate; currently inert and dependency-free. Use `base64-ng-tokio` for the admitted async helper and streaming adapter surface. |
219219
| `kani` | no | Reserved for verifier harnesses; normal builds do not require Kani. |
220220
| `fuzzing` | no | Reserved for verifier and fuzz harness integration; published crate stays dependency-free. |
221221

@@ -1123,7 +1123,7 @@ Security commitments:
11231123
- [docs/ASYNC.md](docs/ASYNC.md) defines the admission bar for async/Tokio
11241124
APIs. The optional companion crate now admits read-all/write-all helpers and
11251125
manual `AsyncRead`/`AsyncWrite` streaming adapters; the core `tokio` feature
1126-
remains deferred and inert.
1126+
remains reserved and inert.
11271127
- [docs/DEPENDENCIES.md](docs/DEPENDENCIES.md) defines the dependency
11281128
admission bar for any future external crate.
11291129
- `runtime::backend_report()` exposes the active admitted backend, detected

docs/PLAN.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,13 @@ Allowed without adding dependencies:
3939

4040
External crates require written justification before inclusion:
4141

42-
- `tokio` may be accepted only behind the optional `tokio` feature for async stream wrappers.
43-
- `serde` may be accepted only behind an optional feature after API and dependency review.
44-
- `bytes` may be accepted only behind an optional feature after API and dependency review.
42+
- `tokio` remains excluded from the core crate; admitted Tokio integration lives
43+
in the optional `base64-ng-tokio` companion crate after async API,
44+
cancellation, backpressure, and dependency review.
45+
- `serde` may be accepted only behind an optional integration crate or feature
46+
after API and dependency review.
47+
- `bytes` may be accepted only behind an optional integration crate or feature
48+
after API and dependency review.
4549
- `zeroize` remains rejected by default; the current direction is an internal
4650
best-effort wiping helper and secret wrapper types before considering a
4751
dependency.
@@ -993,9 +997,9 @@ those expensive wrapped/public-surface harnesses for background runs.
993997
- CT-oriented secret decode remains scalar unless a separate formal
994998
side-channel evidence package proves otherwise. Do not route CT decode
995999
through normal SIMD decode.
996-
- Tokio read-side streaming exists only if the cancellation/drop/buffering
997-
evidence is complete. Tokio writer streaming remains explicitly deferred for
998-
`1.3.0` unless a later slice admits it separately.
1000+
- Tokio reader and writer streaming exist in `base64-ng-tokio` only because the
1001+
cancellation/drop/buffering evidence is complete for that companion crate.
1002+
The core crate's `tokio` feature remains inert.
9991003
- Const decode exists with a clear strict `Result` contract and does not add a
10001004
runtime panic surface.
10011005
- Kani, fuzz, Miri, dudect, generated assembly, benchmark, unsafe-boundary,

release-notes/RELEASE_NOTES_1.3.3.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ wasm `simd128` runtime-dispatch profile with explicit runtime smoke evidence.
4141
before admitted strict decode backend use, preserving overlap safety by
4242
copying encoded chunks into fixed scratch buffers before writing decoded
4343
bytes behind the unread input cursor.
44+
- Aligned roadmap and README wording with the current async split: the core
45+
`tokio` feature remains inert, while `base64-ng-tokio` is the admitted
46+
async helper and streaming adapter surface.
4447
- Added release-gated wasm SIMD codegen evidence through
4548
`scripts/generate_wasm_simd_evidence.sh`, which emits test-harness LLVM IR
4649
with `target-feature=+simd128` when the wasm target is installed.

0 commit comments

Comments
 (0)