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

Add legacy mode in documentation

Browse Source
This commit is contained in:
shakeelrao
2019-03-18 20:33:15 -07:00
parent 20aa1b455c
commit 0a3fa6f909
16 changed files with 39 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/zstd.h
+1 -1
View File
@@ -1115,7 +1115,7 @@ ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t
* @return : - upper-bound for the decompressed size of all data in all successive frames
* - if an error occured: ZSTD_CONTENTSIZE_ERROR
*
* note 1 : an error can occur if `src` contains a legacy frame or an invalid/incorrectly formatted frame.
* note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
* note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD encoded frame of `src`.
* in this case, `ZSTD_findDecompressedSize` and `ZSTD_decompressBound` return the same value.
* note 3 : when the decompressed size field isn't available, the upper-bound for that frame is calculated by: