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

changed enum type name to ZSTD_ResetDirective

Browse Source 
for naming consistency :
types should start with a capital letter (after prefix)
This commit is contained in:
Yann Collet
2018-11-20 12:00:20 -08:00
parent 3b838abf97
commit 114bd4346e
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/zstd_manual.html
+3 -3
View File
@@ -625,9 +625,9 @@ int ZSTD_cParam_upperBound(ZSTD_cParameter cParam);
ZSTD_reset_session_only = 1, ZSTD_reset_session_only = 1,
ZSTD_reset_parameters = 2, ZSTD_reset_parameters = 2,
ZSTD_reset_session_and_parameters = 3 ZSTD_reset_session_and_parameters = 3
} ZSTD_reset_directive; } ZSTD_ResetDirective;
</b></pre><BR> </b></pre><BR>
<pre><b>size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_reset_directive reset); <pre><b>size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_ResetDirective reset);
</b><p> There are 2 different things that can be reset, independently or jointly : </b><p> There are 2 different things that can be reset, independently or jointly :
- The session : will stop compressing current frame, and make CCtx ready to start a new one. - The session : will stop compressing current frame, and make CCtx ready to start a new one.
Useful after an error, or to interrupt any ongoing compression. Useful after an error, or to interrupt any ongoing compression.
@@ -735,7 +735,7 @@ int ZSTD_cParam_upperBound(ZSTD_cParameter cParam);
</p></pre><BR> </p></pre><BR>
<pre><b>size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_reset_directive reset); <pre><b>size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_ResetDirective reset);
</b><p> Return a DCtx to clean state. </b><p> Return a DCtx to clean state.
Session and parameters can be reset jointly or separately Session and parameters can be reset jointly or separately
Parameters can only be reset when no active frame is being decompressed. Parameters can only be reset when no active frame is being decompressed.
lib/compress/zstd_compress.c
+1 -1
View File
@@ -672,7 +672,7 @@ size_t ZSTD_CCtx_refPrefix_advanced(
/*! ZSTD_CCtx_reset() : /*! ZSTD_CCtx_reset() :
* Also dumps dictionary */ * Also dumps dictionary */
size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_reset_directive reset) size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_ResetDirective reset)
{ {
if ( (reset == ZSTD_reset_session_only) if ( (reset == ZSTD_reset_session_only)
|| (reset == ZSTD_reset_session_and_parameters) ) { || (reset == ZSTD_reset_session_and_parameters) ) {
lib/decompress/zstd_decompress.c
+1 -1
View File
@@ -1585,7 +1585,7 @@ size_t ZSTD_decompress_generic_simpleArgs (
return cErr; return cErr;
} }
size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_reset_directive reset) size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_ResetDirective reset)
{ {
if ( (reset == ZSTD_reset_session_only) if ( (reset == ZSTD_reset_session_only)
|| (reset == ZSTD_reset_session_and_parameters) ) { || (reset == ZSTD_reset_session_and_parameters) ) {
lib/zstd.h
+3 -3
View File
@@ -722,7 +722,7 @@ typedef enum {
ZSTD_reset_session_only = 1, ZSTD_reset_session_only = 1,
ZSTD_reset_parameters = 2, ZSTD_reset_parameters = 2,
ZSTD_reset_session_and_parameters = 3 ZSTD_reset_session_and_parameters = 3
} ZSTD_reset_directive; } ZSTD_ResetDirective;
/*! ZSTD_CCtx_reset() : /*! ZSTD_CCtx_reset() :
* There are 2 different things that can be reset, independently or jointly : * There are 2 different things that can be reset, independently or jointly :
@@ -738,7 +738,7 @@ typedef enum {
* otherwise the reset fails, and function returns an error value (which can be tested using ZSTD_isError()) * otherwise the reset fails, and function returns an error value (which can be tested using ZSTD_isError())
* - Both : similar to resetting the session, followed by resetting parameters. * - Both : similar to resetting the session, followed by resetting parameters.
*/ */
ZSTDLIB_API size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_reset_directive reset); ZSTDLIB_API size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_ResetDirective reset);
@@ -853,7 +853,7 @@ ZSTDLIB_API size_t ZSTD_DCtx_refPrefix(ZSTD_DCtx* dctx,
* Parameters can only be reset when no active frame is being decompressed. * Parameters can only be reset when no active frame is being decompressed.
* @return : 0, or an error code, which can be tested with ZSTD_isError() * @return : 0, or an error code, which can be tested with ZSTD_isError()
*/ */
ZSTDLIB_API size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_reset_directive reset); ZSTDLIB_API size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_ResetDirective reset);
/*! ZSTD_decompress_generic() : /*! ZSTD_decompress_generic() :