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

docs(rust): document shared decompression scheduler

Browse Source 
Record the shared-destination decompression scheduler as a Rust-owned boundary while documenting that C retains destination, resource, and format callbacks.

Test Plan:
- git diff --cached --check
This commit is contained in:
ddidderr
2026-07-19 11:10:29 +02:00
parent 802cb70184
commit bc8c005c23
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
rust/README.md
+4 -2
View File
@@ -121,8 +121,9 @@ zstd ABI:
loop, zstd stream-compression I/O loop, scalar adaptive decisions, loop, zstd stream-compression I/O loop, scalar adaptive decisions,
optional-format decompression loops, decompression result policy/final optional-format decompression loops, decompression result policy/final
accounting, and both shared- and separate-destination multi-file accounting, and both shared- and separate-destination multi-file
compression schedulers. C retains destination-name construction and the compression schedulers, plus the shared-destination decompression
private file/resource callbacks for the separate-destination path. scheduler. C retains destination-name construction and the private
file/resource/format callbacks for these scheduler boundaries.
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.
@@ -138,6 +139,7 @@ zstd ABI:
Dictionary-ingestion dispatch, CCtx dictionary/prefix attachment dispatch, the Dictionary-ingestion dispatch, CCtx dictionary/prefix attachment dispatch, the
CLI zstd compression stream loop, scalar adaptive decisions, and the CLI zstd compression stream loop, scalar adaptive decisions, and the
shared- and separate-destination multi-file compression schedulers, shared- and separate-destination multi-file compression schedulers,
shared-destination decompression scheduling,
single-threaded stream initialization and the buffered/stable stream state single-threaded stream initialization and the buffered/stable stream state
machine, MT stream initialization, MT outer scheduling and flush policy, MT machine, MT stream initialization, MT outer scheduling and flush policy, MT
compression-job stage sequencing and error flow, public sequence-API compression-job stage sequencing and error flow, public sequence-API