sharpetronics/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-12-06 00:02:05 -05:00
Code Issues Projects Releases Wiki Activity

update ZSTD_splitBlock() documentation

Browse Source
This commit is contained in:
Yann Collet 2024-10-25 16:25:02 -07:00
parent e557abc8a0
commit 5b4ce643f0
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lib/compress/zstd_preSplit.h
View File

@ -19,14 +19,16 @@ extern "C" {
#define ZSTD_SLIPBLOCK_WORKSPACESIZE 8208 #define ZSTD_SLIPBLOCK_WORKSPACESIZE 8208
/* @level must be a value between 0 and 3. /* ZSTD_splitBlock():
* higher levels spend more energy to find block boundaries * @level must be a value between 0 and 4.
* @workspace must be aligned on 8-bytes boundaries * higher levels spend more energy to detect block boundaries.
* @workspace must be aligned for size_t.
* @wkspSize must be at least >= ZSTD_SLIPBLOCK_WORKSPACESIZE * @wkspSize must be at least >= ZSTD_SLIPBLOCK_WORKSPACESIZE
* note2: * note:
* for the time being, this function only accepts full 128 KB blocks, * For the time being, this function only accepts full 128 KB blocks.
* therefore @blockSizeMax must be == 128 KB. * Therefore, @blockSize must be == 128 KB.
* This could be extended to smaller sizes in the future. * While this could be extended to smaller sizes in the future,
* it is not yet clear if this would be useful. TBD.
*/ */
size_t ZSTD_splitBlock(const void* blockStart, size_t blockSize, size_t ZSTD_splitBlock(const void* blockStart, size_t blockSize,
int level, int level,