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

doc : clarified advanced API usage

Browse Source 
sticky parameters only work with `ZSTD_compress_generic()`
This commit is contained in:
Yann Collet
2018-04-10 11:40:36 -07:00
parent ad5ba6cdcf
commit 04212178b5
1 changed files with 9 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/zstd.h
+9 -16
View File
@@ -906,24 +906,17 @@ ZSTDLIB_API ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
/** New advanced API (experimental) */ /** New advanced API (experimental) */
/* ============================================ */ /* ============================================ */
/* notes on API design : /* API design :
* In this proposal, parameters are pushed one by one into an existing context, * In this advanced API, parameters are pushed one by one into an existing context,
* and then applied on all subsequent compression jobs. * using ZSTD_CCtx_set*() functions.
* When no parameter is ever provided, CCtx is created with compression level ZSTD_CLEVEL_DEFAULT. * Pushed parameters are sticky : they are applied to next job, and any subsequent job.
* It's possible to reset parameters to "default" using ZSTD_CCtx_reset().
* Important : "sticky" parameters only work with `ZSTD_compress_generic()` !
* For any other entry point, "sticky" parameters are ignored !
* *
* This API is intended to replace all others advanced / experimental API entry points. * This API is intended to replace all others advanced / experimental API entry points.
*/ */
/* note on naming convention :
* Initially, the API favored names like ZSTD_setCCtxParameter() .
* In this proposal, convention is changed towards ZSTD_CCtx_setParameter() .
* The main driver is that it identifies more clearly the target object type.
* It feels clearer when considering multiple targets :
* ZSTD_CDict_setParameter() (rather than ZSTD_setCDictParameter())
* ZSTD_CCtxParams_setParameter() (rather than ZSTD_setCCtxParamsParameter() )
* etc...
*/
/* note on enum design : /* note on enum design :
* All enum will be pinned to explicit values before reaching "stable API" status */ * All enum will be pinned to explicit values before reaching "stable API" status */
@@ -1143,8 +1136,8 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
* Useful after an error, or to interrupt an ongoing compression job and start a new one. * Useful after an error, or to interrupt an ongoing compression job and start a new one.
* Any internal data not yet flushed is cancelled. * Any internal data not yet flushed is cancelled.
* Dictionary (if any) is dropped. * Dictionary (if any) is dropped.
* All parameters are back to default values. * All parameters are back to default values (compression level is ZSTD_CLEVEL_DEFAULT).
* It's possible to modify compression parameters after a reset. * After a reset, all compression parameters can be modified again.
*/ */
ZSTDLIB_API void ZSTD_CCtx_reset(ZSTD_CCtx* cctx); ZSTDLIB_API void ZSTD_CCtx_reset(ZSTD_CCtx* cctx);