ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(rust): document sequence and adaptive boundaries

Browse Source 
Document that public sequence API orchestration and scalar CLI adaptive
decisions are Rust-owned while private codec/context state and mutation
callbacks remain in C.

Test Plan:
- git diff --cached --check
- documentation-only boundary update; code validation is covered by
  3b989ab3e and b04893799

Commit is intentionally unsigned because GPG pinentry hangs in this
non-interactive environment.
This commit is contained in:
ddidderr
2026-07-19 10:15:01 +02:00
parent b048937992
commit 11120fd70c
1 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
rust/README.md
+11 -7
View File
@@ -59,6 +59,8 @@ zstd ABI:
stream-initialization policy: dictionary selection, parameter resolution, stream-initialization policy: dictionary selection, parameter resolution,
initial buffer sizing, and the ordered setup decisions are projected into initial buffer sizing, and the ordered setup decisions are projected into
Rust while C retains the private contexts and mutation callbacks. Rust while C retains the private contexts and mutation callbacks.
The public sequence APIs likewise use Rust-owned validation, frame-header,
checksum, and output-accounting orchestration around C-owned block state.
- `zstd_compress_params` owns the compression-level tables (formerly - `zstd_compress_params` owns the compression-level tables (formerly
`clevels.h`), parameter bounds, clamping, validation, table selection, `clevels.h`), parameter bounds, clamping, validation, table selection,
source/dictionary adjustment, and match-state/CDict size estimation. source/dictionary adjustment, and match-state/CDict size estimation.
@@ -112,9 +114,10 @@ zstd ABI:
so library builds do not acquire program-only dependencies. The C so library builds do not acquire program-only dependencies. The C
`fileio` layer retains the format-specific codec callbacks, private `fileio` layer retains the format-specific codec callbacks, private
asynchronous-pool adapters, metadata, zstd codec/error mapping, and asynchronous-pool adapters, metadata, zstd codec/error mapping, and
adaptive compression policy, while Rust owns the mixed-format adaptive-policy integration, while Rust owns the mixed-format probe/dispatch
probe/dispatch loop, zstd stream-compression I/O loop, optional-format loop, zstd stream-compression I/O loop, scalar adaptive decisions,
decompression loops, and decompression result policy/final accounting. optional-format decompression loops, and decompression result policy/final
accounting.
Rust already owns the file preference policy, filename decisions, Rust already owns the file preference policy, filename decisions,
source/destination opening, dictionary buffers, asynchronous I/O pools, source/destination opening, dictionary buffers, asynchronous I/O pools,
and pass-through copy leaf. and pass-through copy leaf.
@@ -128,10 +131,11 @@ zstd ABI:
tests do not compile. tests do not compile.
Dictionary-ingestion dispatch, CCtx dictionary/prefix attachment dispatch, the Dictionary-ingestion dispatch, CCtx dictionary/prefix attachment dispatch, the
CLI zstd compression stream loop, single-threaded stream initialization and the CLI zstd compression stream loop and scalar adaptive decisions,
buffered/stable stream state machine, MT stream initialization, MT outer single-threaded stream initialization and the buffered/stable stream state
scheduling and flush policy, MT compression-job stage sequencing and error machine, MT stream initialization, MT outer scheduling and flush policy, MT
flow, sequence-store and block policy, compression-job stage sequencing and error flow, public sequence-API
orchestration, sequence-store and block policy,
external-sequence/literals block loop, optional-format decompression loops, external-sequence/literals block loop, optional-format decompression loops,
block decoder wrappers, and decompression result policy now run in Rust. CDict block decoder wrappers, and decompression result policy now run in Rust. CDict
lifecycle, the private dictionary-content loader, reset policy, private lifecycle, the private dictionary-content loader, reset policy, private