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

doc: add mention of frame checksum incompatibility

Browse Source 
for new prototype ZSTD_compressSequencesAndLiterals()
This commit is contained in:
Yann Collet
2024-12-20 10:36:57 -08:00
parent 08edecb78c
commit e0f3aaee46
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/zstd.h
+3 -2
View File
@@ -1660,10 +1660,11 @@ ZSTD_compressSequences( ZSTD_CCtx* cctx, void* dst, size_t dstSize,
/*! ZSTD_compressSequencesAndLiterals() : /*! ZSTD_compressSequencesAndLiterals() :
* This is a variant of ZSTD_compressSequences() which, * This is a variant of ZSTD_compressSequences() which,
* instead of receiving (src,srcSize) as input parameter, receives (literals,litSize), * instead of receiving (src,srcSize) as input parameter, receives (literals,litSize),
* aka all literals already extracted and grouped into a single continuous buffer. * aka all literals already extracted and laid out into a single continuous buffer.
* This can be useful if the process generating the sequences also happens to generate the buffer of literals, * This can be useful if the process generating the sequences also happens to generate the buffer of literals,
* thus skipping an extraction + caching stage. * thus skipping an extraction + caching stage.
* To be valid, `litSize` must be equal to the sum of all @.litLength fields in @inSeqs. * To be valid, @litSize must be equal to the sum of all @.litLength fields in @inSeqs.
* Important: Employing this prototype is incompatible with frame checksum.
* @return : final compressed size, or a ZSTD error code. * @return : final compressed size, or a ZSTD error code.
*/ */
ZSTDLIB_STATIC_API size_t ZSTDLIB_STATIC_API size_t