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

add stylistic changes

Browse Source
This commit is contained in:
shakeelrao
2019-03-01 18:29:35 -08:00
parent 2bb5eec711
commit 1e08c49f75
2 changed files with 29 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/zstd.h
+5 -5
View File
@@ -1104,16 +1104,16 @@ typedef enum {
ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
/** ZSTD_decompressBound() :
* currently incompatible with legacy mode
* `src` must point to the start of a ZSTD frame or a skippeable frame
* `srcSize` must be at least as large as the frame contained
* `src` should point the start of a series of ZSTD encoded and/or skippable frames
* `srcSize` must be the _exact_ size of this series
* (i.e. there should be a frame boundary exactly at `srcSize` bytes after `src`)
* @return : - the maximum decompressed size of the compressed source
* - if an error occured: ZSTD_CONTENTSIZE_ERROR
*
* note 1 : an error can occur if `src` points to a legacy frame or an invalid/incorrectly formatted frame.
* note 2 : the bound is exact when Frame_Content_Size field is available in EVERY frame of `src`.
* note 2 : the bound is exact when Frame_Content_Size field is available in _every_ frame of `src`.
* note 3 : when Frame_Content_Size isn't provided, the upper-bound for that frame is calculated by:
* upper-bound = min(128 KB, Window_Size)
* upper-bound = # blocks * min(128 KB, Window_Size)
* note 4 : we always use Frame_Content_Size to bound the decompressed frame size if it's present.
*/
ZSTDLIB_API unsigned long long ZSTD_decompressBound(const void* src, size_t srcSice);