include/linux/zstd.h

67  * zstd_min_clevel() - minimum allowed compression level
69  * Return: The minimum allowed compression level.
74  * zstd_max_clevel() - maximum allowed compression level
76  * Return: The maximum allowed compression level.
81  * zstd_default_clevel() - default compression level
83  * Return: Default compression level.
107  * enum zstd_strategy - zstd compression search strategy
114  * struct zstd_compression_parameters - zstd compression parameters
116  *                compression, and more memory needed during decompression.
117  * @chainLog:     Fully searched segment. Larger means more compression,
119  * @hashLog:      Dispatch table. Larger means more compression,
121  * @searchLog:    Number of searches. Larger means more compression and slower.
123  *                sometimes less compression.
125  *                more compression, and slower.
126  * @strategy:     The zstd compression strategy.
139  *                   header when using dictionary compression.
147  * @cParams: The compression parameters.
154  * @level:              The compression level
165  * @level:              The compression level
179  * zstd_cctx_set_param() - sets a compression parameter
188 /* ======   Single-pass Compression   ====== */
192  * @parameters: The compression parameters to be used.
194  * If multiple compression parameters might be used, the caller must call
207  * @parameters: The compression parameters to be used.
209  * If multiple compression parameters might be used, the caller must call
218  * zstd_init_cctx() - initialize a zstd compression context
224  * Return:          A zstd compression context or NULL on error.
236  * @parameters:   The compression parameters to be used.
245  * zstd_create_cctx_advanced() - Create compression context
248  * Return:        NULL on error, pointer to compression context otherwise.
253  * zstd_free_cctx() - Free compression context
254  * @cdict:        Pointer to compression context.
261  * struct zstd_cdict - Compression dictionary.
267  * zstd_create_cdict_byreference() - Create compression dictionary
277  * Return:             NULL on error, pointer to compression dictionary
285  * zstd_free_cdict() - Free compression dictionary
286  * @cdict:        Pointer to compression dictionary.
438 /* ======   Streaming Compression   ====== */
444  * @cparams: The compression parameters to be used for compression.
454  * @cparams: The compression parameters to be used for compression.
462  * zstd_init_cstream() - initialize a zstd streaming compression context
463  * @parameters        The zstd parameters to use for compression.
474  * Return:            The zstd streaming compression context or NULL on error.
481  * @cstream:          The zstd streaming compression context to reset.
496  * @cstream: The zstd streaming compression context.
516  * @cstream: The zstd streaming compression context.
522  * calling it too often will degrade the compression ratio.
531  * @cstream: The zstd streaming compression context.
673  * @cctx: The zstd compression context.