1#[doc = "Introduction\n\nzstd, short for Zstandard, is a fast lossless compression algorithm, targeting\nreal-time compression scenarios at zlib-level and better compression ratios.\nThe zstd compression library provides in-memory compression and decompression\nfunctions.\n\nThe library supports regular compression levels from 1 up to ZSTD_maxCLevel(),\nwhich is currently 22. Levels >= 20, labeled `--ultra`, should be used with\ncaution, as they require more memory. The library also offers negative\ncompression levels, which extend the range of speed vs. ratio preferences.\nThe lower the level, the faster the speed (at the cost of compression).\n\nCompression can be done in:\n- a single step (described as Simple API)\n- a single step, reusing a context (described as Explicit context)\n- unbounded multiple steps (described as Streaming compression)\n\nThe compression ratio achievable on small data can be highly improved using\na dictionary. Dictionary compression can be performed in:\n- a single step (described as Simple dictionary API)\n- a single step, reusing a dictionary (described as Bulk-processing\ndictionary API)\n\nAdvanced experimental functions can be accessed using\n`#define ZSTD_STATIC_LINKING_ONLY` before including zstd.h.\n\nAdvanced experimental APIs should never be used with a dynamically-linked\nlibrary. They are not \"stable\"; their definitions or signatures may change in\nthe future. Only static linking is allowed."]
39pub const ZSTD_VERSION_MAJOR: u32 = 1;
40pub const ZSTD_VERSION_MINOR: u32 = 5;
41pub const ZSTD_VERSION_RELEASE: u32 = 7;
42pub const ZSTD_VERSION_NUMBER: u32 = 10507;
43pub const ZSTD_CLEVEL_DEFAULT: u32 = 3;
44pub const ZSTD_MAGICNUMBER: u32 = 4247762216;
45pub const ZSTD_MAGIC_DICTIONARY: u32 = 3962610743;
46pub const ZSTD_MAGIC_SKIPPABLE_START: u32 = 407710288;
47pub const ZSTD_MAGIC_SKIPPABLE_MASK: u32 = 4294967280;
48pub const ZSTD_BLOCKSIZELOG_MAX: u32 = 17;
49pub const ZSTD_BLOCKSIZE_MAX: u32 = 131072;
50#[doc = " ZSTD_getFrameContentSize() : requires v1.3.0+\n `src` should point to the start of a ZSTD encoded frame.\n `srcSize` must be at least as large as the frame header.\n hint : any size >= `ZSTD_frameHeaderSize_max` is large enough.\n @return : - decompressed size of `src` frame content, if known\n - ZSTD_CONTENTSIZE_UNKNOWN if the size cannot be determined\n - ZSTD_CONTENTSIZE_ERROR if an error occurred (e.g. invalid magic number, srcSize too small)\n note 1 : a 0 return value means the frame is valid but \"empty\".\n When invoking this method on a skippable frame, it will return 0.\n note 2 : decompressed size is an optional field, it may not be present (typically in streaming mode).\n When `return==ZSTD_CONTENTSIZE_UNKNOWN`, data to decompress could be any size.\n In which case, it's necessary to use streaming mode to decompress data.\n Optionally, application can rely on some implicit limit,\n as ZSTD_decompress() only needs an upper bound of decompressed size.\n (For example, data could be necessarily cut into blocks <= 16 KB).\n note 3 : decompressed size is always present when compression is completed using single-pass functions,\n such as ZSTD_compress(), ZSTD_compressCCtx() ZSTD_compress_usingDict() or ZSTD_compress_usingCDict().\n note 4 : decompressed size can be very large (64-bits value),\n potentially larger than what local system can handle as a single memory segment.\n In which case, it's necessary to use streaming mode to decompress data.\n note 5 : If source is untrusted, decompressed size could be wrong or intentionally modified.\n Always ensure return value fits within application's authorized limits.\n Each application can set its own limits.\n note 6 : This function replaces ZSTD_getDecompressedSize()"]
51pub const ZSTD_CONTENTSIZE_UNKNOWN: i32 = -1;
52pub const ZSTD_CONTENTSIZE_ERROR: i32 = -2;
53pub const ZSTD_FRAMEHEADERSIZE_MAX: u32 = 18;
54pub const ZSTD_SKIPPABLEHEADERSIZE: u32 = 8;
55pub const ZSTD_WINDOWLOG_MAX_32: u32 = 30;
56pub const ZSTD_WINDOWLOG_MAX_64: u32 = 31;
57pub const ZSTD_WINDOWLOG_MIN: u32 = 10;
58pub const ZSTD_HASHLOG_MIN: u32 = 6;
59pub const ZSTD_CHAINLOG_MAX_32: u32 = 29;
60pub const ZSTD_CHAINLOG_MAX_64: u32 = 30;
61pub const ZSTD_CHAINLOG_MIN: u32 = 6;
62pub const ZSTD_SEARCHLOG_MIN: u32 = 1;
63pub const ZSTD_MINMATCH_MAX: u32 = 7;
64pub const ZSTD_MINMATCH_MIN: u32 = 3;
65pub const ZSTD_TARGETLENGTH_MAX: u32 = 131072;
66pub const ZSTD_TARGETLENGTH_MIN: u32 = 0;
67pub const ZSTD_BLOCKSIZE_MAX_MIN: u32 = 1024;
68pub const ZSTD_OVERLAPLOG_MIN: u32 = 0;
69pub const ZSTD_OVERLAPLOG_MAX: u32 = 9;
70pub const ZSTD_WINDOWLOG_LIMIT_DEFAULT: u32 = 27;
71pub const ZSTD_LDM_HASHLOG_MIN: u32 = 6;
72pub const ZSTD_LDM_MINMATCH_MIN: u32 = 4;
73pub const ZSTD_LDM_MINMATCH_MAX: u32 = 4096;
74pub const ZSTD_LDM_BUCKETSIZELOG_MIN: u32 = 1;
75pub const ZSTD_LDM_BUCKETSIZELOG_MAX: u32 = 8;
76pub const ZSTD_LDM_HASHRATELOG_MIN: u32 = 0;
77pub const ZSTD_TARGETCBLOCKSIZE_MIN: u32 = 1340;
78pub const ZSTD_TARGETCBLOCKSIZE_MAX: u32 = 131072;
79pub const ZSTD_SRCSIZEHINT_MIN: u32 = 0;
80pub const ZSTD_BLOCKSPLITTER_LEVEL_MAX: u32 = 6;
81#[repr(u32)]
82#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
83pub enum ZSTD_ErrorCode {
84 ZSTD_error_no_error = 0,
85 ZSTD_error_GENERIC = 1,
86 ZSTD_error_prefix_unknown = 10,
87 ZSTD_error_version_unsupported = 12,
88 ZSTD_error_frameParameter_unsupported = 14,
89 ZSTD_error_frameParameter_windowTooLarge = 16,
90 ZSTD_error_corruption_detected = 20,
91 ZSTD_error_checksum_wrong = 22,
92 ZSTD_error_literals_headerWrong = 24,
93 ZSTD_error_dictionary_corrupted = 30,
94 ZSTD_error_dictionary_wrong = 32,
95 ZSTD_error_dictionaryCreation_failed = 34,
96 ZSTD_error_parameter_unsupported = 40,
97 ZSTD_error_parameter_combination_unsupported = 41,
98 ZSTD_error_parameter_outOfBound = 42,
99 ZSTD_error_tableLog_tooLarge = 44,
100 ZSTD_error_maxSymbolValue_tooLarge = 46,
101 ZSTD_error_maxSymbolValue_tooSmall = 48,
102 ZSTD_error_cannotProduce_uncompressedBlock = 49,
103 ZSTD_error_stabilityCondition_notRespected = 50,
104 ZSTD_error_stage_wrong = 60,
105 ZSTD_error_init_missing = 62,
106 ZSTD_error_memory_allocation = 64,
107 ZSTD_error_workSpace_tooSmall = 66,
108 ZSTD_error_dstSize_tooSmall = 70,
109 ZSTD_error_srcSize_wrong = 72,
110 ZSTD_error_dstBuffer_null = 74,
111 ZSTD_error_noForwardProgress_destFull = 80,
112 ZSTD_error_noForwardProgress_inputEmpty = 82,
113 ZSTD_error_frameIndex_tooLarge = 100,
114 ZSTD_error_seekableIO = 102,
115 ZSTD_error_dstBuffer_wrong = 104,
116 ZSTD_error_srcBuffer_wrong = 105,
117 ZSTD_error_sequenceProducer_failed = 106,
118 ZSTD_error_externalSequences_invalid = 107,
119 ZSTD_error_maxCode = 120,
120}
121extern "C" {
122 pub fn ZSTD_getErrorString(
123 code: ZSTD_ErrorCode,
124 ) -> *const ::core::ffi::c_char;
125}
126extern "C" {
127 #[doc = " ZSTD_versionNumber() :\n Return runtime library version, the value is (MAJOR*100*100 + MINOR*100 + RELEASE)."]
128 pub fn ZSTD_versionNumber() -> ::core::ffi::c_uint;
129}
130extern "C" {
131 #[doc = " ZSTD_versionString() :\n Return runtime library version, like \"1.4.5\". Requires v1.3.0+."]
132 pub fn ZSTD_versionString() -> *const ::core::ffi::c_char;
133}
134extern "C" {
135 #[doc = " Simple Core API\n/\n/*! ZSTD_compress() :\n Compresses `src` content as a single zstd compressed frame into already allocated `dst`.\n NOTE: Providing `dstCapacity >= ZSTD_compressBound(srcSize)` guarantees that zstd will have\n enough space to successfully compress the data.\n @return : compressed size written into `dst` (<= `dstCapacity),\n or an error code if it fails (which can be tested using ZSTD_isError())."]
136 pub fn ZSTD_compress(
137 dst: *mut ::core::ffi::c_void,
138 dstCapacity: usize,
139 src: *const ::core::ffi::c_void,
140 srcSize: usize,
141 compressionLevel: ::core::ffi::c_int,
142 ) -> usize;
143}
144extern "C" {
145 #[doc = " ZSTD_decompress() :\n `compressedSize` : must be the _exact_ size of some number of compressed and/or skippable frames.\n Multiple compressed frames can be decompressed at once with this method.\n The result will be the concatenation of all decompressed frames, back to back.\n `dstCapacity` is an upper bound of originalSize to regenerate.\n First frame's decompressed size can be extracted using ZSTD_getFrameContentSize().\n If maximum upper bound isn't known, prefer using streaming mode to decompress data.\n @return : the number of bytes decompressed into `dst` (<= `dstCapacity`),\n or an errorCode if it fails (which can be tested using ZSTD_isError())."]
146 pub fn ZSTD_decompress(
147 dst: *mut ::core::ffi::c_void,
148 dstCapacity: usize,
149 src: *const ::core::ffi::c_void,
150 compressedSize: usize,
151 ) -> usize;
152}
153extern "C" {
154 pub fn ZSTD_getFrameContentSize(
155 src: *const ::core::ffi::c_void,
156 srcSize: usize,
157 ) -> ::core::ffi::c_ulonglong;
158}
159extern "C" {
160 #[doc = " ZSTD_getDecompressedSize() (obsolete):\n This function is now obsolete, in favor of ZSTD_getFrameContentSize().\n Both functions work the same way, but ZSTD_getDecompressedSize() blends\n \"empty\", \"unknown\" and \"error\" results to the same return value (0),\n while ZSTD_getFrameContentSize() gives them separate return values.\n @return : decompressed size of `src` frame content _if known and not empty_, 0 otherwise."]
161 pub fn ZSTD_getDecompressedSize(
162 src: *const ::core::ffi::c_void,
163 srcSize: usize,
164 ) -> ::core::ffi::c_ulonglong;
165}
166extern "C" {
167 #[doc = " ZSTD_findFrameCompressedSize() : Requires v1.4.0+\n `src` should point to the start of a ZSTD frame or skippable frame.\n `srcSize` must be >= first frame size\n @return : the compressed size of the first frame starting at `src`,\n suitable to pass as `srcSize` to `ZSTD_decompress` or similar,\n or an error code if input is invalid\n Note 1: this method is called _find*() because it's not enough to read the header,\n it may have to scan through the frame's content, to reach its end.\n Note 2: this method also works with Skippable Frames. In which case,\n it returns the size of the complete skippable frame,\n which is always equal to its content size + 8 bytes for headers."]
168 pub fn ZSTD_findFrameCompressedSize(
169 src: *const ::core::ffi::c_void,
170 srcSize: usize,
171 ) -> usize;
172}
173extern "C" {
174 pub fn ZSTD_compressBound(srcSize: usize) -> usize;
175}
176extern "C" {
177 pub fn ZSTD_isError(result: usize) -> ::core::ffi::c_uint;
178}
179extern "C" {
180 pub fn ZSTD_getErrorCode(functionResult: usize) -> ZSTD_ErrorCode;
181}
182extern "C" {
183 pub fn ZSTD_getErrorName(result: usize) -> *const ::core::ffi::c_char;
184}
185extern "C" {
186 pub fn ZSTD_minCLevel() -> ::core::ffi::c_int;
187}
188extern "C" {
189 pub fn ZSTD_maxCLevel() -> ::core::ffi::c_int;
190}
191extern "C" {
192 pub fn ZSTD_defaultCLevel() -> ::core::ffi::c_int;
193}
194#[repr(C)]
195#[derive(Debug, Copy, Clone)]
196pub struct ZSTD_CCtx_s {
197 _unused: [u8; 0],
198}
199#[doc = " Explicit context"]
200pub type ZSTD_CCtx = ZSTD_CCtx_s;
201extern "C" {
202 pub fn ZSTD_createCCtx() -> *mut ZSTD_CCtx;
203}
204extern "C" {
205 pub fn ZSTD_freeCCtx(cctx: *mut ZSTD_CCtx) -> usize;
206}
207extern "C" {
208 #[doc = " ZSTD_compressCCtx() :\n Same as ZSTD_compress(), using an explicit ZSTD_CCtx.\n Important : in order to mirror `ZSTD_compress()` behavior,\n this function compresses at the requested compression level,\n __ignoring any other advanced parameter__ .\n If any advanced parameter was set using the advanced API,\n they will all be reset. Only @compressionLevel remains."]
209 pub fn ZSTD_compressCCtx(
210 cctx: *mut ZSTD_CCtx,
211 dst: *mut ::core::ffi::c_void,
212 dstCapacity: usize,
213 src: *const ::core::ffi::c_void,
214 srcSize: usize,
215 compressionLevel: ::core::ffi::c_int,
216 ) -> usize;
217}
218#[repr(C)]
219#[derive(Debug, Copy, Clone)]
220pub struct ZSTD_DCtx_s {
221 _unused: [u8; 0],
222}
223pub type ZSTD_DCtx = ZSTD_DCtx_s;
224extern "C" {
225 pub fn ZSTD_createDCtx() -> *mut ZSTD_DCtx;
226}
227extern "C" {
228 pub fn ZSTD_freeDCtx(dctx: *mut ZSTD_DCtx) -> usize;
229}
230extern "C" {
231 #[doc = " ZSTD_decompressDCtx() :\n Same as ZSTD_decompress(),\n requires an allocated ZSTD_DCtx.\n Compatible with sticky parameters (see below)."]
232 pub fn ZSTD_decompressDCtx(
233 dctx: *mut ZSTD_DCtx,
234 dst: *mut ::core::ffi::c_void,
235 dstCapacity: usize,
236 src: *const ::core::ffi::c_void,
237 srcSize: usize,
238 ) -> usize;
239}
240#[repr(u32)]
241#[doc = " Advanced compression API (Requires v1.4.0+)"]
242#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
243pub enum ZSTD_strategy {
244 ZSTD_fast = 1,
245 ZSTD_dfast = 2,
246 ZSTD_greedy = 3,
247 ZSTD_lazy = 4,
248 ZSTD_lazy2 = 5,
249 ZSTD_btlazy2 = 6,
250 ZSTD_btopt = 7,
251 ZSTD_btultra = 8,
252 ZSTD_btultra2 = 9,
253}
254#[repr(u32)]
255#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
256pub enum ZSTD_cParameter {
257 ZSTD_c_compressionLevel = 100,
258 ZSTD_c_windowLog = 101,
259 ZSTD_c_hashLog = 102,
260 ZSTD_c_chainLog = 103,
261 ZSTD_c_searchLog = 104,
262 ZSTD_c_minMatch = 105,
263 ZSTD_c_targetLength = 106,
264 ZSTD_c_strategy = 107,
265 ZSTD_c_targetCBlockSize = 130,
266 ZSTD_c_enableLongDistanceMatching = 160,
267 ZSTD_c_ldmHashLog = 161,
268 ZSTD_c_ldmMinMatch = 162,
269 ZSTD_c_ldmBucketSizeLog = 163,
270 ZSTD_c_ldmHashRateLog = 164,
271 ZSTD_c_contentSizeFlag = 200,
272 ZSTD_c_checksumFlag = 201,
273 ZSTD_c_dictIDFlag = 202,
274 ZSTD_c_nbWorkers = 400,
275 ZSTD_c_jobSize = 401,
276 ZSTD_c_overlapLog = 402,
277 ZSTD_c_experimentalParam1 = 500,
278 ZSTD_c_experimentalParam2 = 10,
279 ZSTD_c_experimentalParam3 = 1000,
280 ZSTD_c_experimentalParam4 = 1001,
281 ZSTD_c_experimentalParam5 = 1002,
282 ZSTD_c_experimentalParam7 = 1004,
283 ZSTD_c_experimentalParam8 = 1005,
284 ZSTD_c_experimentalParam9 = 1006,
285 ZSTD_c_experimentalParam10 = 1007,
286 ZSTD_c_experimentalParam11 = 1008,
287 ZSTD_c_experimentalParam12 = 1009,
288 ZSTD_c_experimentalParam13 = 1010,
289 ZSTD_c_experimentalParam14 = 1011,
290 ZSTD_c_experimentalParam15 = 1012,
291 ZSTD_c_experimentalParam16 = 1013,
292 ZSTD_c_experimentalParam17 = 1014,
293 ZSTD_c_experimentalParam18 = 1015,
294 ZSTD_c_experimentalParam19 = 1016,
295 ZSTD_c_experimentalParam20 = 1017,
296}
297#[repr(C)]
298#[derive(Debug, Copy, Clone)]
299pub struct ZSTD_bounds {
300 pub error: usize,
301 pub lowerBound: ::core::ffi::c_int,
302 pub upperBound: ::core::ffi::c_int,
303}
304extern "C" {
305 #[doc = " ZSTD_cParam_getBounds() :\n All parameters must belong to an interval with lower and upper bounds,\n otherwise they will either trigger an error or be automatically clamped.\n @return : a structure, ZSTD_bounds, which contains\n - an error status field, which must be tested using ZSTD_isError()\n - lower and upper bounds, both inclusive"]
306 pub fn ZSTD_cParam_getBounds(cParam: ZSTD_cParameter) -> ZSTD_bounds;
307}
308extern "C" {
309 #[doc = " ZSTD_CCtx_setParameter() :\n Set one compression parameter, selected by enum ZSTD_cParameter.\n All parameters have valid bounds. Bounds can be queried using ZSTD_cParam_getBounds().\n Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter).\n Setting a parameter is generally only possible during frame initialization (before starting compression).\n Exception : when using multi-threading mode (nbWorkers >= 1),\n the following parameters can be updated _during_ compression (within same frame):\n => compressionLevel, hashLog, chainLog, searchLog, minMatch, targetLength and strategy.\n new parameters will be active for next job only (after a flush()).\n @return : an error code (which can be tested using ZSTD_isError())."]
310 pub fn ZSTD_CCtx_setParameter(
311 cctx: *mut ZSTD_CCtx,
312 param: ZSTD_cParameter,
313 value: ::core::ffi::c_int,
314 ) -> usize;
315}
316extern "C" {
317 #[doc = " ZSTD_CCtx_setPledgedSrcSize() :\n Total input data size to be compressed as a single frame.\n Value will be written in frame header, unless if explicitly forbidden using ZSTD_c_contentSizeFlag.\n This value will also be controlled at end of frame, and trigger an error if not respected.\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.\n In order to mean \"unknown content size\", pass constant ZSTD_CONTENTSIZE_UNKNOWN.\n ZSTD_CONTENTSIZE_UNKNOWN is default value for any new frame.\n Note 2 : pledgedSrcSize is only valid once, for the next frame.\n It's discarded at the end of the frame, and replaced by ZSTD_CONTENTSIZE_UNKNOWN.\n Note 3 : Whenever all input data is provided and consumed in a single round,\n for example with ZSTD_compress2(),\n or invoking immediately ZSTD_compressStream2(,,,ZSTD_e_end),\n this value is automatically overridden by srcSize instead."]
318 pub fn ZSTD_CCtx_setPledgedSrcSize(
319 cctx: *mut ZSTD_CCtx,
320 pledgedSrcSize: ::core::ffi::c_ulonglong,
321 ) -> usize;
322}
323#[repr(u32)]
324#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
325pub enum ZSTD_ResetDirective {
326 ZSTD_reset_session_only = 1,
327 ZSTD_reset_parameters = 2,
328 ZSTD_reset_session_and_parameters = 3,
329}
330extern "C" {
331 #[doc = " ZSTD_CCtx_reset() :\n There are 2 different things that can be reset, independently or jointly :\n - The session : will stop compressing current frame, and make CCtx ready to start a new one.\n Useful after an error, or to interrupt any ongoing compression.\n Any internal data not yet flushed is cancelled.\n Compression parameters and dictionary remain unchanged.\n They will be used to compress next frame.\n Resetting session never fails.\n - The parameters : changes all parameters back to \"default\".\n This also removes any reference to any dictionary or external sequence producer.\n Parameters can only be changed between 2 sessions (i.e. no compression is currently ongoing)\n otherwise the reset fails, and function returns an error value (which can be tested using ZSTD_isError())\n - Both : similar to resetting the session, followed by resetting parameters."]
332 pub fn ZSTD_CCtx_reset(
333 cctx: *mut ZSTD_CCtx,
334 reset: ZSTD_ResetDirective,
335 ) -> usize;
336}
337extern "C" {
338 #[doc = " ZSTD_compress2() :\n Behave the same as ZSTD_compressCCtx(), but compression parameters are set using the advanced API.\n (note that this entry point doesn't even expose a compression level parameter).\n ZSTD_compress2() always starts a new frame.\n Should cctx hold data from a previously unfinished frame, everything about it is forgotten.\n - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()\n - The function is always blocking, returns when compression is completed.\n NOTE: Providing `dstCapacity >= ZSTD_compressBound(srcSize)` guarantees that zstd will have\n enough space to successfully compress the data, though it is possible it fails for other reasons.\n @return : compressed size written into `dst` (<= `dstCapacity),\n or an error code if it fails (which can be tested using ZSTD_isError())."]
339 pub fn ZSTD_compress2(
340 cctx: *mut ZSTD_CCtx,
341 dst: *mut ::core::ffi::c_void,
342 dstCapacity: usize,
343 src: *const ::core::ffi::c_void,
344 srcSize: usize,
345 ) -> usize;
346}
347#[repr(u32)]
348#[doc = " Advanced decompression API (Requires v1.4.0+)"]
349#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
350pub enum ZSTD_dParameter {
351 ZSTD_d_windowLogMax = 100,
352 ZSTD_d_experimentalParam1 = 1000,
353 ZSTD_d_experimentalParam2 = 1001,
354 ZSTD_d_experimentalParam3 = 1002,
355 ZSTD_d_experimentalParam4 = 1003,
356 ZSTD_d_experimentalParam5 = 1004,
357 ZSTD_d_experimentalParam6 = 1005,
358}
359extern "C" {
360 #[doc = " ZSTD_dParam_getBounds() :\n All parameters must belong to an interval with lower and upper bounds,\n otherwise they will either trigger an error or be automatically clamped.\n @return : a structure, ZSTD_bounds, which contains\n - an error status field, which must be tested using ZSTD_isError()\n - both lower and upper bounds, inclusive"]
361 pub fn ZSTD_dParam_getBounds(dParam: ZSTD_dParameter) -> ZSTD_bounds;
362}
363extern "C" {
364 #[doc = " ZSTD_DCtx_setParameter() :\n Set one compression parameter, selected by enum ZSTD_dParameter.\n All parameters have valid bounds. Bounds can be queried using ZSTD_dParam_getBounds().\n Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter).\n Setting a parameter is only possible during frame initialization (before starting decompression).\n @return : 0, or an error code (which can be tested using ZSTD_isError())."]
365 pub fn ZSTD_DCtx_setParameter(
366 dctx: *mut ZSTD_DCtx,
367 param: ZSTD_dParameter,
368 value: ::core::ffi::c_int,
369 ) -> usize;
370}
371extern "C" {
372 #[doc = " ZSTD_DCtx_reset() :\n Return a DCtx to clean state.\n Session and parameters can be reset jointly or separately.\n Parameters can only be reset when no active frame is being decompressed.\n @return : 0, or an error code, which can be tested with ZSTD_isError()"]
373 pub fn ZSTD_DCtx_reset(
374 dctx: *mut ZSTD_DCtx,
375 reset: ZSTD_ResetDirective,
376 ) -> usize;
377}
378#[doc = " Streaming"]
379#[repr(C)]
380#[derive(Debug, Copy, Clone)]
381pub struct ZSTD_inBuffer_s {
382 #[doc = "< start of input buffer"]
383 pub src: *const ::core::ffi::c_void,
384 #[doc = "< size of input buffer"]
385 pub size: usize,
386 #[doc = "< position where reading stopped. Will be updated. Necessarily 0 <= pos <= size"]
387 pub pos: usize,
388}
389#[doc = " Streaming"]
390pub type ZSTD_inBuffer = ZSTD_inBuffer_s;
391#[repr(C)]
392#[derive(Debug, Copy, Clone)]
393pub struct ZSTD_outBuffer_s {
394 #[doc = "< start of output buffer"]
395 pub dst: *mut ::core::ffi::c_void,
396 #[doc = "< size of output buffer"]
397 pub size: usize,
398 #[doc = "< position where writing stopped. Will be updated. Necessarily 0 <= pos <= size"]
399 pub pos: usize,
400}
401pub type ZSTD_outBuffer = ZSTD_outBuffer_s;
402pub type ZSTD_CStream = ZSTD_CCtx;
403extern "C" {
404 pub fn ZSTD_createCStream() -> *mut ZSTD_CStream;
405}
406extern "C" {
407 pub fn ZSTD_freeCStream(zcs: *mut ZSTD_CStream) -> usize;
408}
409#[repr(u32)]
410#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
411pub enum ZSTD_EndDirective {
412 ZSTD_e_continue = 0,
413 ZSTD_e_flush = 1,
414 ZSTD_e_end = 2,
415}
416extern "C" {
417 #[doc = " ZSTD_compressStream2() : Requires v1.4.0+\n Behaves about the same as ZSTD_compressStream, with additional control on end directive.\n - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()\n - Compression parameters cannot be changed once compression is started (save a list of exceptions in multi-threading mode)\n - output->pos must be <= dstCapacity, input->pos must be <= srcSize\n - output->pos and input->pos will be updated. They are guaranteed to remain below their respective limit.\n - endOp must be a valid directive\n - When nbWorkers==0 (default), function is blocking : it completes its job before returning to caller.\n - When nbWorkers>=1, function is non-blocking : it copies a portion of input, distributes jobs to internal worker threads, flush to output whatever is available,\n and then immediately returns, just indicating that there is some data remaining to be flushed.\n The function nonetheless guarantees forward progress : it will return only after it reads or write at least 1+ byte.\n - Exception : if the first call requests a ZSTD_e_end directive and provides enough dstCapacity, the function delegates to ZSTD_compress2() which is always blocking.\n - @return provides a minimum amount of data remaining to be flushed from internal buffers\n or an error code, which can be tested using ZSTD_isError().\n if @return != 0, flush is not fully completed, there is still some data left within internal buffers.\n This is useful for ZSTD_e_flush, since in this case more flushes are necessary to empty all buffers.\n For ZSTD_e_end, @return == 0 when internal buffers are fully flushed and frame is completed.\n - after a ZSTD_e_end directive, if internal buffer is not fully flushed (@return != 0),\n only ZSTD_e_end or ZSTD_e_flush operations are allowed.\n Before starting a new compression job, or changing compression parameters,\n it is required to fully flush internal buffers.\n - note: if an operation ends with an error, it may leave @cctx in an undefined state.\n Therefore, it's UB to invoke ZSTD_compressStream2() of ZSTD_compressStream() on such a state.\n In order to be re-employed after an error, a state must be reset,\n which can be done explicitly (ZSTD_CCtx_reset()),\n or is sometimes implied by methods starting a new compression job (ZSTD_initCStream(), ZSTD_compressCCtx())"]
418 pub fn ZSTD_compressStream2(
419 cctx: *mut ZSTD_CCtx,
420 output: *mut ZSTD_outBuffer,
421 input: *mut ZSTD_inBuffer,
422 endOp: ZSTD_EndDirective,
423 ) -> usize;
424}
425extern "C" {
426 pub fn ZSTD_CStreamInSize() -> usize;
427}
428extern "C" {
429 pub fn ZSTD_CStreamOutSize() -> usize;
430}
431extern "C" {
432 #[doc = " Equivalent to:\n\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)\n ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);\n\n Note that ZSTD_initCStream() clears any previously set dictionary. Use the new API\n to compress with a dictionary."]
433 pub fn ZSTD_initCStream(
434 zcs: *mut ZSTD_CStream,
435 compressionLevel: ::core::ffi::c_int,
436 ) -> usize;
437}
438extern "C" {
439 #[doc = " Alternative for ZSTD_compressStream2(zcs, output, input, ZSTD_e_continue).\n NOTE: The return value is different. ZSTD_compressStream() returns a hint for\n the next read size (if non-zero and not an error). ZSTD_compressStream2()\n returns the minimum nb of bytes left to flush (if non-zero and not an error)."]
440 pub fn ZSTD_compressStream(
441 zcs: *mut ZSTD_CStream,
442 output: *mut ZSTD_outBuffer,
443 input: *mut ZSTD_inBuffer,
444 ) -> usize;
445}
446extern "C" {
447 #[doc = " Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_flush)."]
448 pub fn ZSTD_flushStream(
449 zcs: *mut ZSTD_CStream,
450 output: *mut ZSTD_outBuffer,
451 ) -> usize;
452}
453extern "C" {
454 #[doc = " Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_end)."]
455 pub fn ZSTD_endStream(
456 zcs: *mut ZSTD_CStream,
457 output: *mut ZSTD_outBuffer,
458 ) -> usize;
459}
460pub type ZSTD_DStream = ZSTD_DCtx;
461extern "C" {
462 pub fn ZSTD_createDStream() -> *mut ZSTD_DStream;
463}
464extern "C" {
465 pub fn ZSTD_freeDStream(zds: *mut ZSTD_DStream) -> usize;
466}
467extern "C" {
468 #[doc = " ZSTD_initDStream() :\n Initialize/reset DStream state for new decompression operation.\n Call before new decompression operation using same DStream.\n\n Note : This function is redundant with the advanced API and equivalent to:\n ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);\n ZSTD_DCtx_refDDict(zds, NULL);"]
469 pub fn ZSTD_initDStream(zds: *mut ZSTD_DStream) -> usize;
470}
471extern "C" {
472 #[doc = " ZSTD_decompressStream() :\n Streaming decompression function.\n Call repetitively to consume full input updating it as necessary.\n Function will update both input and output `pos` fields exposing current state via these fields:\n - `input.pos < input.size`, some input remaining and caller should provide remaining input\n on the next call.\n - `output.pos < output.size`, decoder flushed internal output buffer.\n - `output.pos == output.size`, unflushed data potentially present in the internal buffers,\n check ZSTD_decompressStream() @return value,\n if > 0, invoke it again to flush remaining data to output.\n Note : with no additional input, amount of data flushed <= ZSTD_BLOCKSIZE_MAX.\n\n @return : 0 when a frame is completely decoded and fully flushed,\n or an error code, which can be tested using ZSTD_isError(),\n or any other value > 0, which means there is some decoding or flushing to do to complete current frame.\n\n Note: when an operation returns with an error code, the @zds state may be left in undefined state.\n It's UB to invoke `ZSTD_decompressStream()` on such a state.\n In order to re-use such a state, it must be first reset,\n which can be done explicitly (`ZSTD_DCtx_reset()`),\n or is implied for operations starting some new decompression job (`ZSTD_initDStream`, `ZSTD_decompressDCtx()`, `ZSTD_decompress_usingDict()`)"]
473 pub fn ZSTD_decompressStream(
474 zds: *mut ZSTD_DStream,
475 output: *mut ZSTD_outBuffer,
476 input: *mut ZSTD_inBuffer,
477 ) -> usize;
478}
479extern "C" {
480 pub fn ZSTD_DStreamInSize() -> usize;
481}
482extern "C" {
483 pub fn ZSTD_DStreamOutSize() -> usize;
484}
485extern "C" {
486 #[doc = " Simple dictionary API\n/\n/*! ZSTD_compress_usingDict() :\n Compression at an explicit compression level using a Dictionary.\n A dictionary can be any arbitrary data segment (also called a prefix),\n or a buffer with specified information (see zdict.h).\n Note : This function loads the dictionary, resulting in significant startup delay.\n It's intended for a dictionary used only once.\n Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used."]
487 pub fn ZSTD_compress_usingDict(
488 ctx: *mut ZSTD_CCtx,
489 dst: *mut ::core::ffi::c_void,
490 dstCapacity: usize,
491 src: *const ::core::ffi::c_void,
492 srcSize: usize,
493 dict: *const ::core::ffi::c_void,
494 dictSize: usize,
495 compressionLevel: ::core::ffi::c_int,
496 ) -> usize;
497}
498extern "C" {
499 #[doc = " ZSTD_decompress_usingDict() :\n Decompression using a known Dictionary.\n Dictionary must be identical to the one used during compression.\n Note : This function loads the dictionary, resulting in significant startup delay.\n It's intended for a dictionary used only once.\n Note : When `dict == NULL || dictSize < 8` no dictionary is used."]
500 pub fn ZSTD_decompress_usingDict(
501 dctx: *mut ZSTD_DCtx,
502 dst: *mut ::core::ffi::c_void,
503 dstCapacity: usize,
504 src: *const ::core::ffi::c_void,
505 srcSize: usize,
506 dict: *const ::core::ffi::c_void,
507 dictSize: usize,
508 ) -> usize;
509}
510#[repr(C)]
511#[derive(Debug, Copy, Clone)]
512pub struct ZSTD_CDict_s {
513 _unused: [u8; 0],
514}
515#[doc = " Bulk processing dictionary API"]
516pub type ZSTD_CDict = ZSTD_CDict_s;
517extern "C" {
518 #[doc = " ZSTD_createCDict() :\n When compressing multiple messages or blocks using the same dictionary,\n it's recommended to digest the dictionary only once, since it's a costly operation.\n ZSTD_createCDict() will create a state from digesting a dictionary.\n The resulting state can be used for future compression operations with very limited startup cost.\n ZSTD_CDict can be created once and shared by multiple threads concurrently, since its usage is read-only.\n @dictBuffer can be released after ZSTD_CDict creation, because its content is copied within CDict.\n Note 1 : Consider experimental function `ZSTD_createCDict_byReference()` if you prefer to not duplicate @dictBuffer content.\n Note 2 : A ZSTD_CDict can be created from an empty @dictBuffer,\n in which case the only thing that it transports is the @compressionLevel.\n This can be useful in a pipeline featuring ZSTD_compress_usingCDict() exclusively,\n expecting a ZSTD_CDict parameter with any data, including those without a known dictionary."]
519 pub fn ZSTD_createCDict(
520 dictBuffer: *const ::core::ffi::c_void,
521 dictSize: usize,
522 compressionLevel: ::core::ffi::c_int,
523 ) -> *mut ZSTD_CDict;
524}
525extern "C" {
526 #[doc = " ZSTD_freeCDict() :\n Function frees memory allocated by ZSTD_createCDict().\n If a NULL pointer is passed, no operation is performed."]
527 pub fn ZSTD_freeCDict(CDict: *mut ZSTD_CDict) -> usize;
528}
529extern "C" {
530 #[doc = " ZSTD_compress_usingCDict() :\n Compression using a digested Dictionary.\n Recommended when same dictionary is used multiple times.\n Note : compression level is _decided at dictionary creation time_,\n and frame parameters are hardcoded (dictID=yes, contentSize=yes, checksum=no)"]
531 pub fn ZSTD_compress_usingCDict(
532 cctx: *mut ZSTD_CCtx,
533 dst: *mut ::core::ffi::c_void,
534 dstCapacity: usize,
535 src: *const ::core::ffi::c_void,
536 srcSize: usize,
537 cdict: *const ZSTD_CDict,
538 ) -> usize;
539}
540#[repr(C)]
541#[derive(Debug, Copy, Clone)]
542pub struct ZSTD_DDict_s {
543 _unused: [u8; 0],
544}
545pub type ZSTD_DDict = ZSTD_DDict_s;
546extern "C" {
547 #[doc = " ZSTD_createDDict() :\n Create a digested dictionary, ready to start decompression operation without startup delay.\n dictBuffer can be released after DDict creation, as its content is copied inside DDict."]
548 pub fn ZSTD_createDDict(
549 dictBuffer: *const ::core::ffi::c_void,
550 dictSize: usize,
551 ) -> *mut ZSTD_DDict;
552}
553extern "C" {
554 #[doc = " ZSTD_freeDDict() :\n Function frees memory allocated with ZSTD_createDDict()\n If a NULL pointer is passed, no operation is performed."]
555 pub fn ZSTD_freeDDict(ddict: *mut ZSTD_DDict) -> usize;
556}
557extern "C" {
558 #[doc = " ZSTD_decompress_usingDDict() :\n Decompression using a digested Dictionary.\n Recommended when same dictionary is used multiple times."]
559 pub fn ZSTD_decompress_usingDDict(
560 dctx: *mut ZSTD_DCtx,
561 dst: *mut ::core::ffi::c_void,
562 dstCapacity: usize,
563 src: *const ::core::ffi::c_void,
564 srcSize: usize,
565 ddict: *const ZSTD_DDict,
566 ) -> usize;
567}
568extern "C" {
569 #[doc = " ZSTD_getDictID_fromDict() : Requires v1.4.0+\n Provides the dictID stored within dictionary.\n if @return == 0, the dictionary is not conformant with Zstandard specification.\n It can still be loaded, but as a content-only dictionary."]
570 pub fn ZSTD_getDictID_fromDict(
571 dict: *const ::core::ffi::c_void,
572 dictSize: usize,
573 ) -> ::core::ffi::c_uint;
574}
575extern "C" {
576 #[doc = " ZSTD_getDictID_fromCDict() : Requires v1.5.0+\n Provides the dictID of the dictionary loaded into `cdict`.\n If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.\n Non-conformant dictionaries can still be loaded, but as content-only dictionaries."]
577 pub fn ZSTD_getDictID_fromCDict(
578 cdict: *const ZSTD_CDict,
579 ) -> ::core::ffi::c_uint;
580}
581extern "C" {
582 #[doc = " ZSTD_getDictID_fromDDict() : Requires v1.4.0+\n Provides the dictID of the dictionary loaded into `ddict`.\n If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.\n Non-conformant dictionaries can still be loaded, but as content-only dictionaries."]
583 pub fn ZSTD_getDictID_fromDDict(
584 ddict: *const ZSTD_DDict,
585 ) -> ::core::ffi::c_uint;
586}
587extern "C" {
588 #[doc = " ZSTD_getDictID_fromFrame() : Requires v1.4.0+\n Provides the dictID required to decompressed the frame stored within `src`.\n If @return == 0, the dictID could not be decoded.\n This could for one of the following reasons :\n - The frame does not require a dictionary to be decoded (most common case).\n - The frame was built with dictID intentionally removed. Whatever dictionary is necessary is a hidden piece of information.\n Note : this use case also happens when using a non-conformant dictionary.\n - `srcSize` is too small, and as a result, the frame header could not be decoded (only possible if `srcSize < ZSTD_FRAMEHEADERSIZE_MAX`).\n - This is not a Zstandard frame.\n When identifying the exact failure cause, it's possible to use ZSTD_getFrameHeader(), which will provide a more precise error code."]
589 pub fn ZSTD_getDictID_fromFrame(
590 src: *const ::core::ffi::c_void,
591 srcSize: usize,
592 ) -> ::core::ffi::c_uint;
593}
594extern "C" {
595 #[doc = " ZSTD_CCtx_loadDictionary() : Requires v1.4.0+\n Create an internal CDict from `dict` buffer.\n Decompression will have to use same dictionary.\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Special: Loading a NULL (or 0-size) dictionary invalidates previous dictionary,\n meaning \"return to no-dictionary mode\".\n Note 1 : Dictionary is sticky, it will be used for all future compressed frames,\n until parameters are reset, a new dictionary is loaded, or the dictionary\n is explicitly invalidated by loading a NULL dictionary.\n Note 2 : Loading a dictionary involves building tables.\n It's also a CPU consuming operation, with non-negligible impact on latency.\n Tables are dependent on compression parameters, and for this reason,\n compression parameters can no longer be changed after loading a dictionary.\n Note 3 :`dict` content will be copied internally.\n Use experimental ZSTD_CCtx_loadDictionary_byReference() to reference content instead.\n In such a case, dictionary buffer must outlive its users.\n Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()\n to precisely select how dictionary content must be interpreted.\n Note 5 : This method does not benefit from LDM (long distance mode).\n If you want to employ LDM on some large dictionary content,\n prefer employing ZSTD_CCtx_refPrefix() described below."]
596 pub fn ZSTD_CCtx_loadDictionary(
597 cctx: *mut ZSTD_CCtx,
598 dict: *const ::core::ffi::c_void,
599 dictSize: usize,
600 ) -> usize;
601}
602extern "C" {
603 #[doc = " ZSTD_CCtx_refCDict() : Requires v1.4.0+\n Reference a prepared dictionary, to be used for all future compressed frames.\n Note that compression parameters are enforced from within CDict,\n and supersede any compression parameter previously set within CCtx.\n The parameters ignored are labelled as \"superseded-by-cdict\" in the ZSTD_cParameter enum docs.\n The ignored parameters will be used again if the CCtx is returned to no-dictionary mode.\n The dictionary will remain valid for future compressed frames using same CCtx.\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Special : Referencing a NULL CDict means \"return to no-dictionary mode\".\n Note 1 : Currently, only one dictionary can be managed.\n Referencing a new dictionary effectively \"discards\" any previous one.\n Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx."]
604 pub fn ZSTD_CCtx_refCDict(
605 cctx: *mut ZSTD_CCtx,
606 cdict: *const ZSTD_CDict,
607 ) -> usize;
608}
609extern "C" {
610 #[doc = " ZSTD_CCtx_refPrefix() : Requires v1.4.0+\n Reference a prefix (single-usage dictionary) for next compressed frame.\n A prefix is **only used once**. Tables are discarded at end of frame (ZSTD_e_end).\n Decompression will need same prefix to properly regenerate data.\n Compressing with a prefix is similar in outcome as performing a diff and compressing it,\n but performs much faster, especially during decompression (compression speed is tunable with compression level).\n This method is compatible with LDM (long distance mode).\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Special: Adding any prefix (including NULL) invalidates any previous prefix or dictionary\n Note 1 : Prefix buffer is referenced. It **must** outlive compression.\n Its content must remain unmodified during compression.\n Note 2 : If the intention is to diff some large src data blob with some prior version of itself,\n ensure that the window size is large enough to contain the entire source.\n See ZSTD_c_windowLog.\n Note 3 : Referencing a prefix involves building tables, which are dependent on compression parameters.\n It's a CPU consuming operation, with non-negligible impact on latency.\n If there is a need to use the same prefix multiple times, consider loadDictionary instead.\n Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dct_rawContent).\n Use experimental ZSTD_CCtx_refPrefix_advanced() to alter dictionary interpretation."]
611 pub fn ZSTD_CCtx_refPrefix(
612 cctx: *mut ZSTD_CCtx,
613 prefix: *const ::core::ffi::c_void,
614 prefixSize: usize,
615 ) -> usize;
616}
617extern "C" {
618 #[doc = " ZSTD_DCtx_loadDictionary() : Requires v1.4.0+\n Create an internal DDict from dict buffer, to be used to decompress all future frames.\n The dictionary remains valid for all future frames, until explicitly invalidated, or\n a new dictionary is loaded.\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Special : Adding a NULL (or 0-size) dictionary invalidates any previous dictionary,\n meaning \"return to no-dictionary mode\".\n Note 1 : Loading a dictionary involves building tables,\n which has a non-negligible impact on CPU usage and latency.\n It's recommended to \"load once, use many times\", to amortize the cost\n Note 2 :`dict` content will be copied internally, so `dict` can be released after loading.\n Use ZSTD_DCtx_loadDictionary_byReference() to reference dictionary content instead.\n Note 3 : Use ZSTD_DCtx_loadDictionary_advanced() to take control of\n how dictionary content is loaded and interpreted."]
619 pub fn ZSTD_DCtx_loadDictionary(
620 dctx: *mut ZSTD_DCtx,
621 dict: *const ::core::ffi::c_void,
622 dictSize: usize,
623 ) -> usize;
624}
625extern "C" {
626 #[doc = " ZSTD_DCtx_refDDict() : Requires v1.4.0+\n Reference a prepared dictionary, to be used to decompress next frames.\n The dictionary remains active for decompression of future frames using same DCtx.\n\n If called with ZSTD_d_refMultipleDDicts enabled, repeated calls of this function\n will store the DDict references in a table, and the DDict used for decompression\n will be determined at decompression time, as per the dict ID in the frame.\n The memory for the table is allocated on the first call to refDDict, and can be\n freed with ZSTD_freeDCtx().\n\n If called with ZSTD_d_refMultipleDDicts disabled (the default), only one dictionary\n will be managed, and referencing a dictionary effectively \"discards\" any previous one.\n\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Special: referencing a NULL DDict means \"return to no-dictionary mode\".\n Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx."]
627 pub fn ZSTD_DCtx_refDDict(
628 dctx: *mut ZSTD_DCtx,
629 ddict: *const ZSTD_DDict,
630 ) -> usize;
631}
632extern "C" {
633 #[doc = " ZSTD_DCtx_refPrefix() : Requires v1.4.0+\n Reference a prefix (single-usage dictionary) to decompress next frame.\n This is the reverse operation of ZSTD_CCtx_refPrefix(),\n and must use the same prefix as the one used during compression.\n Prefix is **only used once**. Reference is discarded at end of frame.\n End of frame is reached when ZSTD_decompressStream() returns 0.\n @result : 0, or an error code (which can be tested with ZSTD_isError()).\n Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary\n Note 2 : Prefix buffer is referenced. It **must** outlive decompression.\n Prefix buffer must remain unmodified up to the end of frame,\n reached when ZSTD_decompressStream() returns 0.\n Note 3 : By default, the prefix is treated as raw content (ZSTD_dct_rawContent).\n Use ZSTD_CCtx_refPrefix_advanced() to alter dictMode (Experimental section)\n Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost.\n A full dictionary is more costly, as it requires building tables."]
634 pub fn ZSTD_DCtx_refPrefix(
635 dctx: *mut ZSTD_DCtx,
636 prefix: *const ::core::ffi::c_void,
637 prefixSize: usize,
638 ) -> usize;
639}
640extern "C" {
641 #[doc = " ZSTD_sizeof_*() : Requires v1.4.0+\n These functions give the _current_ memory usage of selected object.\n Note that object memory usage can evolve (increase or decrease) over time."]
642 pub fn ZSTD_sizeof_CCtx(cctx: *const ZSTD_CCtx) -> usize;
643}
644extern "C" {
645 pub fn ZSTD_sizeof_DCtx(dctx: *const ZSTD_DCtx) -> usize;
646}
647extern "C" {
648 pub fn ZSTD_sizeof_CStream(zcs: *const ZSTD_CStream) -> usize;
649}
650extern "C" {
651 pub fn ZSTD_sizeof_DStream(zds: *const ZSTD_DStream) -> usize;
652}
653extern "C" {
654 pub fn ZSTD_sizeof_CDict(cdict: *const ZSTD_CDict) -> usize;
655}
656extern "C" {
657 pub fn ZSTD_sizeof_DDict(ddict: *const ZSTD_DDict) -> usize;
658}
659#[repr(C)]
660#[derive(Debug, Copy, Clone)]
661pub struct ZSTD_CCtx_params_s {
662 _unused: [u8; 0],
663}
664pub type ZSTD_CCtx_params = ZSTD_CCtx_params_s;
665#[repr(C)]
666#[derive(Debug, Copy, Clone)]
667pub struct ZSTD_Sequence {
668 pub offset: ::core::ffi::c_uint,
669 pub litLength: ::core::ffi::c_uint,
670 pub matchLength: ::core::ffi::c_uint,
671 pub rep: ::core::ffi::c_uint,
672}
673#[repr(C)]
674#[derive(Debug, Copy, Clone)]
675pub struct ZSTD_compressionParameters {
676 #[doc = "< largest match distance : larger == more compression, more memory needed during decompression"]
677 pub windowLog: ::core::ffi::c_uint,
678 #[doc = "< fully searched segment : larger == more compression, slower, more memory (useless for fast)"]
679 pub chainLog: ::core::ffi::c_uint,
680 #[doc = "< dispatch table : larger == faster, more memory"]
681 pub hashLog: ::core::ffi::c_uint,
682 #[doc = "< nb of searches : larger == more compression, slower"]
683 pub searchLog: ::core::ffi::c_uint,
684 #[doc = "< match length searched : larger == faster decompression, sometimes less compression"]
685 pub minMatch: ::core::ffi::c_uint,
686 #[doc = "< acceptable match size for optimal parser (only) : larger == more compression, slower"]
687 pub targetLength: ::core::ffi::c_uint,
688 #[doc = "< see ZSTD_strategy definition above"]
689 pub strategy: ZSTD_strategy,
690}
691#[repr(C)]
692#[derive(Debug, Copy, Clone)]
693pub struct ZSTD_frameParameters {
694 #[doc = "< 1: content size will be in frame header (when known)"]
695 pub contentSizeFlag: ::core::ffi::c_int,
696 #[doc = "< 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection"]
697 pub checksumFlag: ::core::ffi::c_int,
698 #[doc = "< 1: no dictID will be saved into frame header (dictID is only useful for dictionary compression)"]
699 pub noDictIDFlag: ::core::ffi::c_int,
700}
701#[repr(C)]
702#[derive(Debug, Copy, Clone)]
703pub struct ZSTD_parameters {
704 pub cParams: ZSTD_compressionParameters,
705 pub fParams: ZSTD_frameParameters,
706}
707#[repr(u32)]
708#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
709pub enum ZSTD_dictContentType_e {
710 ZSTD_dct_auto = 0,
711 ZSTD_dct_rawContent = 1,
712 ZSTD_dct_fullDict = 2,
713}
714#[repr(u32)]
715#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
716pub enum ZSTD_dictLoadMethod_e {
717 #[doc = "< Copy dictionary content internally"]
718 ZSTD_dlm_byCopy = 0,
719 #[doc = "< Reference dictionary content -- the dictionary buffer must outlive its users."]
720 ZSTD_dlm_byRef = 1,
721}
722#[repr(u32)]
723#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
724pub enum ZSTD_format_e {
725 ZSTD_f_zstd1 = 0,
726 ZSTD_f_zstd1_magicless = 1,
727}
728#[repr(u32)]
729#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
730pub enum ZSTD_forceIgnoreChecksum_e {
731 ZSTD_d_validateChecksum = 0,
732 ZSTD_d_ignoreChecksum = 1,
733}
734#[repr(u32)]
735#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
736pub enum ZSTD_refMultipleDDicts_e {
737 ZSTD_rmd_refSingleDDict = 0,
738 ZSTD_rmd_refMultipleDDicts = 1,
739}
740#[repr(u32)]
741#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
742pub enum ZSTD_dictAttachPref_e {
743 ZSTD_dictDefaultAttach = 0,
744 ZSTD_dictForceAttach = 1,
745 ZSTD_dictForceCopy = 2,
746 ZSTD_dictForceLoad = 3,
747}
748#[repr(u32)]
749#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
750pub enum ZSTD_literalCompressionMode_e {
751 #[doc = "< Automatically determine the compression mode based on the compression level.\n Negative compression levels will be uncompressed, and positive compression\n levels will be compressed."]
752 ZSTD_lcm_auto = 0,
753 #[doc = "< Always attempt Huffman compression. Uncompressed literals will still be\n emitted if Huffman compression is not profitable."]
754 ZSTD_lcm_huffman = 1,
755 #[doc = "< Always emit uncompressed literals."]
756 ZSTD_lcm_uncompressed = 2,
757}
758#[repr(u32)]
759#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
760pub enum ZSTD_ParamSwitch_e {
761 ZSTD_ps_auto = 0,
762 ZSTD_ps_enable = 1,
763 ZSTD_ps_disable = 2,
764}
765extern "C" {
766 #[doc = " ZSTD_findDecompressedSize() :\n `src` should point to the start of a series of ZSTD encoded and/or skippable frames\n `srcSize` must be the _exact_ size of this series\n (i.e. there should be a frame boundary at `src + srcSize`)\n @return : - decompressed size of all data in all successive frames\n - if the decompressed size cannot be determined: ZSTD_CONTENTSIZE_UNKNOWN\n - if an error occurred: ZSTD_CONTENTSIZE_ERROR\n\n note 1 : decompressed size is an optional field, that may not be present, especially in streaming mode.\n When `return==ZSTD_CONTENTSIZE_UNKNOWN`, data to decompress could be any size.\n In which case, it's necessary to use streaming mode to decompress data.\n note 2 : decompressed size is always present when compression is done with ZSTD_compress()\n note 3 : decompressed size can be very large (64-bits value),\n potentially larger than what local system can handle as a single memory segment.\n In which case, it's necessary to use streaming mode to decompress data.\n note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.\n Always ensure result fits within application's authorized limits.\n Each application can set its own limits.\n note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input to\n read each contained frame header. This is fast as most of the data is skipped,\n however it does mean that all frame data must be present and valid."]
767 pub fn ZSTD_findDecompressedSize(
768 src: *const ::core::ffi::c_void,
769 srcSize: usize,
770 ) -> ::core::ffi::c_ulonglong;
771}
772extern "C" {
773 #[doc = " ZSTD_decompressBound() :\n `src` should point to the start of a series of ZSTD encoded and/or skippable frames\n `srcSize` must be the _exact_ size of this series\n (i.e. there should be a frame boundary at `src + srcSize`)\n @return : - upper-bound for the decompressed size of all data in all successive frames\n - if an error occurred: ZSTD_CONTENTSIZE_ERROR\n\n note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.\n note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD encoded frame of `src`.\n in this case, `ZSTD_findDecompressedSize` and `ZSTD_decompressBound` return the same value.\n note 3 : when the decompressed size field isn't available, the upper-bound for that frame is calculated by:\n upper-bound = # blocks * min(128 KB, Window_Size)"]
774 pub fn ZSTD_decompressBound(
775 src: *const ::core::ffi::c_void,
776 srcSize: usize,
777 ) -> ::core::ffi::c_ulonglong;
778}
779extern "C" {
780 #[doc = " ZSTD_frameHeaderSize() :\n srcSize must be large enough, aka >= ZSTD_FRAMEHEADERSIZE_PREFIX.\n @return : size of the Frame Header,\n or an error code (if srcSize is too small)"]
781 pub fn ZSTD_frameHeaderSize(
782 src: *const ::core::ffi::c_void,
783 srcSize: usize,
784 ) -> usize;
785}
786#[repr(u32)]
787#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
788pub enum ZSTD_FrameType_e {
789 ZSTD_frame = 0,
790 ZSTD_skippableFrame = 1,
791}
792#[repr(C)]
793#[derive(Debug, Copy, Clone)]
794pub struct ZSTD_FrameHeader {
795 pub frameContentSize: ::core::ffi::c_ulonglong,
796 pub windowSize: ::core::ffi::c_ulonglong,
797 pub blockSizeMax: ::core::ffi::c_uint,
798 pub frameType: ZSTD_FrameType_e,
799 pub headerSize: ::core::ffi::c_uint,
800 pub dictID: ::core::ffi::c_uint,
801 pub checksumFlag: ::core::ffi::c_uint,
802 pub _reserved1: ::core::ffi::c_uint,
803 pub _reserved2: ::core::ffi::c_uint,
804}
805extern "C" {
806 #[doc = " ZSTD_getFrameHeader() :\n decode Frame Header into `zfhPtr`, or requires larger `srcSize`.\n @return : 0 => header is complete, `zfhPtr` is correctly filled,\n >0 => `srcSize` is too small, @return value is the wanted `srcSize` amount, `zfhPtr` is not filled,\n or an error code, which can be tested using ZSTD_isError()"]
807 pub fn ZSTD_getFrameHeader(
808 zfhPtr: *mut ZSTD_FrameHeader,
809 src: *const ::core::ffi::c_void,
810 srcSize: usize,
811 ) -> usize;
812}
813extern "C" {
814 #[doc = " ZSTD_getFrameHeader_advanced() :\n same as ZSTD_getFrameHeader(),\n with added capability to select a format (like ZSTD_f_zstd1_magicless)"]
815 pub fn ZSTD_getFrameHeader_advanced(
816 zfhPtr: *mut ZSTD_FrameHeader,
817 src: *const ::core::ffi::c_void,
818 srcSize: usize,
819 format: ZSTD_format_e,
820 ) -> usize;
821}
822extern "C" {
823 #[doc = " ZSTD_decompressionMargin() :\n Zstd supports in-place decompression, where the input and output buffers overlap.\n In this case, the output buffer must be at least (Margin + Output_Size) bytes large,\n and the input buffer must be at the end of the output buffer.\n\n _______________________ Output Buffer ________________________\n | |\n | ____ Input Buffer ____|\n | | |\n v v v\n |---------------------------------------|-----------|----------|\n ^ ^ ^\n |___________________ Output_Size ___________________|_ Margin _|\n\n NOTE: See also ZSTD_DECOMPRESSION_MARGIN().\n NOTE: This applies only to single-pass decompression through ZSTD_decompress() or\n ZSTD_decompressDCtx().\n NOTE: This function supports multi-frame input.\n\n @param src The compressed frame(s)\n @param srcSize The size of the compressed frame(s)\n @returns The decompression margin or an error that can be checked with ZSTD_isError()."]
824 pub fn ZSTD_decompressionMargin(
825 src: *const ::core::ffi::c_void,
826 srcSize: usize,
827 ) -> usize;
828}
829#[repr(u32)]
830#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
831pub enum ZSTD_SequenceFormat_e {
832 ZSTD_sf_noBlockDelimiters = 0,
833 ZSTD_sf_explicitBlockDelimiters = 1,
834}
835extern "C" {
836 #[doc = " ZSTD_sequenceBound() :\n `srcSize` : size of the input buffer\n @return : upper-bound for the number of sequences that can be generated\n from a buffer of srcSize bytes\n\n note : returns number of sequences - to get bytes, multiply by sizeof(ZSTD_Sequence)."]
837 pub fn ZSTD_sequenceBound(srcSize: usize) -> usize;
838}
839extern "C" {
840 #[doc = " ZSTD_generateSequences() :\n WARNING: This function is meant for debugging and informational purposes ONLY!\n Its implementation is flawed, and it will be deleted in a future version.\n It is not guaranteed to succeed, as there are several cases where it will give\n up and fail. You should NOT use this function in production code.\n\n This function is deprecated, and will be removed in a future version.\n\n Generate sequences using ZSTD_compress2(), given a source buffer.\n\n @param zc The compression context to be used for ZSTD_compress2(). Set any\n compression parameters you need on this context.\n @param outSeqs The output sequences buffer of size @p outSeqsSize\n @param outSeqsCapacity The size of the output sequences buffer.\n ZSTD_sequenceBound(srcSize) is an upper bound on the number\n of sequences that can be generated.\n @param src The source buffer to generate sequences from of size @p srcSize.\n @param srcSize The size of the source buffer.\n\n Each block will end with a dummy sequence\n with offset == 0, matchLength == 0, and litLength == length of last literals.\n litLength may be == 0, and if so, then the sequence of (of: 0 ml: 0 ll: 0)\n simply acts as a block delimiter.\n\n @returns The number of sequences generated, necessarily less than\n ZSTD_sequenceBound(srcSize), or an error code that can be checked\n with ZSTD_isError()."]
841 pub fn ZSTD_generateSequences(
842 zc: *mut ZSTD_CCtx,
843 outSeqs: *mut ZSTD_Sequence,
844 outSeqsCapacity: usize,
845 src: *const ::core::ffi::c_void,
846 srcSize: usize,
847 ) -> usize;
848}
849extern "C" {
850 #[doc = " ZSTD_mergeBlockDelimiters() :\n Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals\n by merging them into the literals of the next sequence.\n\n As such, the final generated result has no explicit representation of block boundaries,\n and the final last literals segment is not represented in the sequences.\n\n The output of this function can be fed into ZSTD_compressSequences() with CCtx\n setting of ZSTD_c_blockDelimiters as ZSTD_sf_noBlockDelimiters\n @return : number of sequences left after merging"]
851 pub fn ZSTD_mergeBlockDelimiters(
852 sequences: *mut ZSTD_Sequence,
853 seqsSize: usize,
854 ) -> usize;
855}
856extern "C" {
857 #[doc = " ZSTD_compressSequences() :\n Compress an array of ZSTD_Sequence, associated with @src buffer, into dst.\n @src contains the entire input (not just the literals).\n If @srcSize > sum(sequence.length), the remaining bytes are considered all literals\n If a dictionary is included, then the cctx should reference the dict (see: ZSTD_CCtx_refCDict(), ZSTD_CCtx_loadDictionary(), etc.).\n The entire source is compressed into a single frame.\n\n The compression behavior changes based on cctx params. In particular:\n If ZSTD_c_blockDelimiters == ZSTD_sf_noBlockDelimiters, the array of ZSTD_Sequence is expected to contain\n no block delimiters (defined in ZSTD_Sequence). Block boundaries are roughly determined based on\n the block size derived from the cctx, and sequences may be split. This is the default setting.\n\n If ZSTD_c_blockDelimiters == ZSTD_sf_explicitBlockDelimiters, the array of ZSTD_Sequence is expected to contain\n valid block delimiters (defined in ZSTD_Sequence). Behavior is undefined if no block delimiters are provided.\n\n When ZSTD_c_blockDelimiters == ZSTD_sf_explicitBlockDelimiters, it's possible to decide generating repcodes\n using the advanced parameter ZSTD_c_repcodeResolution. Repcodes will improve compression ratio, though the benefit\n can vary greatly depending on Sequences. On the other hand, repcode resolution is an expensive operation.\n By default, it's disabled at low (<10) compression levels, and enabled above the threshold (>=10).\n ZSTD_c_repcodeResolution makes it possible to directly manage this processing in either direction.\n\n If ZSTD_c_validateSequences == 0, this function blindly accepts the Sequences provided. Invalid Sequences cause undefined\n behavior. If ZSTD_c_validateSequences == 1, then the function will detect invalid Sequences (see doc/zstd_compression_format.md for\n specifics regarding offset/matchlength requirements) and then bail out and return an error.\n\n In addition to the two adjustable experimental params, there are other important cctx params.\n - ZSTD_c_minMatch MUST be set as less than or equal to the smallest match generated by the match finder. It has a minimum value of ZSTD_MINMATCH_MIN.\n - ZSTD_c_compressionLevel accordingly adjusts the strength of the entropy coder, as it would in typical compression.\n - ZSTD_c_windowLog affects offset validation: this function will return an error at higher debug levels if a provided offset\n is larger than what the spec allows for a given window log and dictionary (if present). See: doc/zstd_compression_format.md\n\n Note: Repcodes are, as of now, always re-calculated within this function, ZSTD_Sequence.rep is effectively unused.\n Dev Note: Once ability to ingest repcodes become available, the explicit block delims mode must respect those repcodes exactly,\n and cannot emit an RLE block that disagrees with the repcode history.\n @return : final compressed size, or a ZSTD error code."]
858 pub fn ZSTD_compressSequences(
859 cctx: *mut ZSTD_CCtx,
860 dst: *mut ::core::ffi::c_void,
861 dstCapacity: usize,
862 inSeqs: *const ZSTD_Sequence,
863 inSeqsSize: usize,
864 src: *const ::core::ffi::c_void,
865 srcSize: usize,
866 ) -> usize;
867}
868extern "C" {
869 #[doc = " ZSTD_compressSequencesAndLiterals() :\n This is a variant of ZSTD_compressSequences() which,\n instead of receiving (src,srcSize) as input parameter, receives (literals,litSize),\n aka all the literals, already extracted and laid out into a single continuous buffer.\n This can be useful if the process generating the sequences also happens to generate the buffer of literals,\n thus skipping an extraction + caching stage.\n It's a speed optimization, useful when the right conditions are met,\n but it also features the following limitations:\n - Only supports explicit delimiter mode\n - Currently does not support Sequences validation (so input Sequences are trusted)\n - Not compatible with frame checksum, which must be disabled\n - If any block is incompressible, will fail and return an error\n - @litSize must be == sum of all @.litLength fields in @inSeqs. Any discrepancy will generate an error.\n - @litBufCapacity is the size of the underlying buffer into which literals are written, starting at address @literals.\n @litBufCapacity must be at least 8 bytes larger than @litSize.\n - @decompressedSize must be correct, and correspond to the sum of all Sequences. Any discrepancy will generate an error.\n @return : final compressed size, or a ZSTD error code."]
870 pub fn ZSTD_compressSequencesAndLiterals(
871 cctx: *mut ZSTD_CCtx,
872 dst: *mut ::core::ffi::c_void,
873 dstCapacity: usize,
874 inSeqs: *const ZSTD_Sequence,
875 nbSequences: usize,
876 literals: *const ::core::ffi::c_void,
877 litSize: usize,
878 litBufCapacity: usize,
879 decompressedSize: usize,
880 ) -> usize;
881}
882extern "C" {
883 #[doc = " ZSTD_writeSkippableFrame() :\n Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.\n\n Skippable frames begin with a 4-byte magic number. There are 16 possible choices of magic number,\n ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.\n As such, the parameter magicVariant controls the exact skippable frame magic number variant used,\n so the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.\n\n Returns an error if destination buffer is not large enough, if the source size is not representable\n with a 4-byte unsigned int, or if the parameter magicVariant is greater than 15 (and therefore invalid).\n\n @return : number of bytes written or a ZSTD error."]
884 pub fn ZSTD_writeSkippableFrame(
885 dst: *mut ::core::ffi::c_void,
886 dstCapacity: usize,
887 src: *const ::core::ffi::c_void,
888 srcSize: usize,
889 magicVariant: ::core::ffi::c_uint,
890 ) -> usize;
891}
892extern "C" {
893 #[doc = " ZSTD_readSkippableFrame() :\n Retrieves the content of a zstd skippable frame starting at @src, and writes it to @dst buffer.\n\n The parameter @magicVariant will receive the magicVariant that was supplied when the frame was written,\n i.e. magicNumber - ZSTD_MAGIC_SKIPPABLE_START.\n This can be NULL if the caller is not interested in the magicVariant.\n\n Returns an error if destination buffer is not large enough, or if the frame is not skippable.\n\n @return : number of bytes written or a ZSTD error."]
894 pub fn ZSTD_readSkippableFrame(
895 dst: *mut ::core::ffi::c_void,
896 dstCapacity: usize,
897 magicVariant: *mut ::core::ffi::c_uint,
898 src: *const ::core::ffi::c_void,
899 srcSize: usize,
900 ) -> usize;
901}
902extern "C" {
903 #[doc = " ZSTD_isSkippableFrame() :\n Tells if the content of `buffer` starts with a valid Frame Identifier for a skippable frame."]
904 pub fn ZSTD_isSkippableFrame(
905 buffer: *const ::core::ffi::c_void,
906 size: usize,
907 ) -> ::core::ffi::c_uint;
908}
909extern "C" {
910 #[doc = " ZSTD_estimate*() :\n These functions make it possible to estimate memory usage\n of a future {D,C}Ctx, before its creation.\n This is useful in combination with ZSTD_initStatic(),\n which makes it possible to employ a static buffer for ZSTD_CCtx* state.\n\n ZSTD_estimateCCtxSize() will provide a memory budget large enough\n to compress data of any size using one-shot compression ZSTD_compressCCtx() or ZSTD_compress2()\n associated with any compression level up to max specified one.\n The estimate will assume the input may be arbitrarily large,\n which is the worst case.\n\n Note that the size estimation is specific for one-shot compression,\n it is not valid for streaming (see ZSTD_estimateCStreamSize*())\n nor other potential ways of using a ZSTD_CCtx* state.\n\n When srcSize can be bound by a known and rather \"small\" value,\n this knowledge can be used to provide a tighter budget estimation\n because the ZSTD_CCtx* state will need less memory for small inputs.\n This tighter estimation can be provided by employing more advanced functions\n ZSTD_estimateCCtxSize_usingCParams(), which can be used in tandem with ZSTD_getCParams(),\n and ZSTD_estimateCCtxSize_usingCCtxParams(), which can be used in tandem with ZSTD_CCtxParams_setParameter().\n Both can be used to estimate memory using custom compression parameters and arbitrary srcSize limits.\n\n Note : only single-threaded compression is supported.\n ZSTD_estimateCCtxSize_usingCCtxParams() will return an error code if ZSTD_c_nbWorkers is >= 1."]
911 pub fn ZSTD_estimateCCtxSize(
912 maxCompressionLevel: ::core::ffi::c_int,
913 ) -> usize;
914}
915extern "C" {
916 pub fn ZSTD_estimateCCtxSize_usingCParams(
917 cParams: ZSTD_compressionParameters,
918 ) -> usize;
919}
920extern "C" {
921 pub fn ZSTD_estimateCCtxSize_usingCCtxParams(
922 params: *const ZSTD_CCtx_params,
923 ) -> usize;
924}
925extern "C" {
926 pub fn ZSTD_estimateDCtxSize() -> usize;
927}
928extern "C" {
929 #[doc = " ZSTD_estimateCStreamSize() :\n ZSTD_estimateCStreamSize() will provide a memory budget large enough for streaming compression\n using any compression level up to the max specified one.\n It will also consider src size to be arbitrarily \"large\", which is a worst case scenario.\n If srcSize is known to always be small, ZSTD_estimateCStreamSize_usingCParams() can provide a tighter estimation.\n ZSTD_estimateCStreamSize_usingCParams() can be used in tandem with ZSTD_getCParams() to create cParams from compressionLevel.\n ZSTD_estimateCStreamSize_usingCCtxParams() can be used in tandem with ZSTD_CCtxParams_setParameter(). Only single-threaded compression is supported. This function will return an error code if ZSTD_c_nbWorkers is >= 1.\n Note : CStream size estimation is only correct for single-threaded compression.\n ZSTD_estimateCStreamSize_usingCCtxParams() will return an error code if ZSTD_c_nbWorkers is >= 1.\n Note 2 : ZSTD_estimateCStreamSize* functions are not compatible with the Block-Level Sequence Producer API at this time.\n Size estimates assume that no external sequence producer is registered.\n\n ZSTD_DStream memory budget depends on frame's window Size.\n This information can be passed manually, using ZSTD_estimateDStreamSize,\n or deducted from a valid frame Header, using ZSTD_estimateDStreamSize_fromFrame();\n Any frame requesting a window size larger than max specified one will be rejected.\n Note : if streaming is init with function ZSTD_init?Stream_usingDict(),\n an internal ?Dict will be created, which additional size is not estimated here.\n In this case, get total size by adding ZSTD_estimate?DictSize"]
930 pub fn ZSTD_estimateCStreamSize(
931 maxCompressionLevel: ::core::ffi::c_int,
932 ) -> usize;
933}
934extern "C" {
935 pub fn ZSTD_estimateCStreamSize_usingCParams(
936 cParams: ZSTD_compressionParameters,
937 ) -> usize;
938}
939extern "C" {
940 pub fn ZSTD_estimateCStreamSize_usingCCtxParams(
941 params: *const ZSTD_CCtx_params,
942 ) -> usize;
943}
944extern "C" {
945 pub fn ZSTD_estimateDStreamSize(maxWindowSize: usize) -> usize;
946}
947extern "C" {
948 pub fn ZSTD_estimateDStreamSize_fromFrame(
949 src: *const ::core::ffi::c_void,
950 srcSize: usize,
951 ) -> usize;
952}
953extern "C" {
954 #[doc = " ZSTD_estimate?DictSize() :\n ZSTD_estimateCDictSize() will bet that src size is relatively \"small\", and content is copied, like ZSTD_createCDict().\n ZSTD_estimateCDictSize_advanced() makes it possible to control compression parameters precisely, like ZSTD_createCDict_advanced().\n Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller."]
955 pub fn ZSTD_estimateCDictSize(
956 dictSize: usize,
957 compressionLevel: ::core::ffi::c_int,
958 ) -> usize;
959}
960extern "C" {
961 pub fn ZSTD_estimateCDictSize_advanced(
962 dictSize: usize,
963 cParams: ZSTD_compressionParameters,
964 dictLoadMethod: ZSTD_dictLoadMethod_e,
965 ) -> usize;
966}
967extern "C" {
968 pub fn ZSTD_estimateDDictSize(
969 dictSize: usize,
970 dictLoadMethod: ZSTD_dictLoadMethod_e,
971 ) -> usize;
972}
973extern "C" {
974 #[doc = " ZSTD_initStatic*() :\n Initialize an object using a pre-allocated fixed-size buffer.\n workspace: The memory area to emplace the object into.\n Provided pointer *must be 8-bytes aligned*.\n Buffer must outlive object.\n workspaceSize: Use ZSTD_estimate*Size() to determine\n how large workspace must be to support target scenario.\n @return : pointer to object (same address as workspace, just different type),\n or NULL if error (size too small, incorrect alignment, etc.)\n Note : zstd will never resize nor malloc() when using a static buffer.\n If the object requires more memory than available,\n zstd will just error out (typically ZSTD_error_memory_allocation).\n Note 2 : there is no corresponding \"free\" function.\n Since workspace is allocated externally, it must be freed externally too.\n Note 3 : cParams : use ZSTD_getCParams() to convert a compression level\n into its associated cParams.\n Limitation 1 : currently not compatible with internal dictionary creation, triggered by\n ZSTD_CCtx_loadDictionary(), ZSTD_initCStream_usingDict() or ZSTD_initDStream_usingDict().\n Limitation 2 : static cctx currently not compatible with multi-threading.\n Limitation 3 : static dctx is incompatible with legacy support."]
975 pub fn ZSTD_initStaticCCtx(
976 workspace: *mut ::core::ffi::c_void,
977 workspaceSize: usize,
978 ) -> *mut ZSTD_CCtx;
979}
980extern "C" {
981 pub fn ZSTD_initStaticCStream(
982 workspace: *mut ::core::ffi::c_void,
983 workspaceSize: usize,
984 ) -> *mut ZSTD_CStream;
985}
986extern "C" {
987 pub fn ZSTD_initStaticDCtx(
988 workspace: *mut ::core::ffi::c_void,
989 workspaceSize: usize,
990 ) -> *mut ZSTD_DCtx;
991}
992extern "C" {
993 pub fn ZSTD_initStaticDStream(
994 workspace: *mut ::core::ffi::c_void,
995 workspaceSize: usize,
996 ) -> *mut ZSTD_DStream;
997}
998extern "C" {
999 pub fn ZSTD_initStaticCDict(
1000 workspace: *mut ::core::ffi::c_void,
1001 workspaceSize: usize,
1002 dict: *const ::core::ffi::c_void,
1003 dictSize: usize,
1004 dictLoadMethod: ZSTD_dictLoadMethod_e,
1005 dictContentType: ZSTD_dictContentType_e,
1006 cParams: ZSTD_compressionParameters,
1007 ) -> *const ZSTD_CDict;
1008}
1009extern "C" {
1010 pub fn ZSTD_initStaticDDict(
1011 workspace: *mut ::core::ffi::c_void,
1012 workspaceSize: usize,
1013 dict: *const ::core::ffi::c_void,
1014 dictSize: usize,
1015 dictLoadMethod: ZSTD_dictLoadMethod_e,
1016 dictContentType: ZSTD_dictContentType_e,
1017 ) -> *const ZSTD_DDict;
1018}
1019#[doc = " Custom memory allocation :\n These prototypes make it possible to pass your own allocation/free functions.\n ZSTD_customMem is provided at creation time, using ZSTD_create*_advanced() variants listed below.\n All allocation/free operations will be completed using these custom variants instead of regular <stdlib.h> ones."]
1020pub type ZSTD_allocFunction = ::core::option::Option<
1021 unsafe extern "C" fn(
1022 opaque: *mut ::core::ffi::c_void,
1023 size: usize,
1024 ) -> *mut ::core::ffi::c_void,
1025>;
1026pub type ZSTD_freeFunction = ::core::option::Option<
1027 unsafe extern "C" fn(
1028 opaque: *mut ::core::ffi::c_void,
1029 address: *mut ::core::ffi::c_void,
1030 ),
1031>;
1032#[repr(C)]
1033#[derive(Debug, Copy, Clone)]
1034pub struct ZSTD_customMem {
1035 pub customAlloc: ZSTD_allocFunction,
1036 pub customFree: ZSTD_freeFunction,
1037 pub opaque: *mut ::core::ffi::c_void,
1038}
1039extern "C" {
1040 #[doc = "< this constant defers to stdlib's functions"]
1041 pub static ZSTD_defaultCMem: ZSTD_customMem;
1042}
1043extern "C" {
1044 pub fn ZSTD_createCCtx_advanced(
1045 customMem: ZSTD_customMem,
1046 ) -> *mut ZSTD_CCtx;
1047}
1048extern "C" {
1049 pub fn ZSTD_createCStream_advanced(
1050 customMem: ZSTD_customMem,
1051 ) -> *mut ZSTD_CStream;
1052}
1053extern "C" {
1054 pub fn ZSTD_createDCtx_advanced(
1055 customMem: ZSTD_customMem,
1056 ) -> *mut ZSTD_DCtx;
1057}
1058extern "C" {
1059 pub fn ZSTD_createDStream_advanced(
1060 customMem: ZSTD_customMem,
1061 ) -> *mut ZSTD_DStream;
1062}
1063extern "C" {
1064 pub fn ZSTD_createCDict_advanced(
1065 dict: *const ::core::ffi::c_void,
1066 dictSize: usize,
1067 dictLoadMethod: ZSTD_dictLoadMethod_e,
1068 dictContentType: ZSTD_dictContentType_e,
1069 cParams: ZSTD_compressionParameters,
1070 customMem: ZSTD_customMem,
1071 ) -> *mut ZSTD_CDict;
1072}
1073#[repr(C)]
1074#[derive(Debug, Copy, Clone)]
1075pub struct POOL_ctx_s {
1076 _unused: [u8; 0],
1077}
1078#[doc = " Thread pool :\n These prototypes make it possible to share a thread pool among multiple compression contexts.\n This can limit resources for applications with multiple threads where each one uses\n a threaded compression mode (via ZSTD_c_nbWorkers parameter).\n ZSTD_createThreadPool creates a new thread pool with a given number of threads.\n Note that the lifetime of such pool must exist while being used.\n ZSTD_CCtx_refThreadPool assigns a thread pool to a context (use NULL argument value\n to use an internal thread pool).\n ZSTD_freeThreadPool frees a thread pool, accepts NULL pointer."]
1079pub type ZSTD_threadPool = POOL_ctx_s;
1080extern "C" {
1081 pub fn ZSTD_createThreadPool(numThreads: usize) -> *mut ZSTD_threadPool;
1082}
1083extern "C" {
1084 pub fn ZSTD_freeThreadPool(pool: *mut ZSTD_threadPool);
1085}
1086extern "C" {
1087 pub fn ZSTD_CCtx_refThreadPool(
1088 cctx: *mut ZSTD_CCtx,
1089 pool: *mut ZSTD_threadPool,
1090 ) -> usize;
1091}
1092extern "C" {
1093 pub fn ZSTD_createCDict_advanced2(
1094 dict: *const ::core::ffi::c_void,
1095 dictSize: usize,
1096 dictLoadMethod: ZSTD_dictLoadMethod_e,
1097 dictContentType: ZSTD_dictContentType_e,
1098 cctxParams: *const ZSTD_CCtx_params,
1099 customMem: ZSTD_customMem,
1100 ) -> *mut ZSTD_CDict;
1101}
1102extern "C" {
1103 pub fn ZSTD_createDDict_advanced(
1104 dict: *const ::core::ffi::c_void,
1105 dictSize: usize,
1106 dictLoadMethod: ZSTD_dictLoadMethod_e,
1107 dictContentType: ZSTD_dictContentType_e,
1108 customMem: ZSTD_customMem,
1109 ) -> *mut ZSTD_DDict;
1110}
1111extern "C" {
1112 #[doc = " ZSTD_createCDict_byReference() :\n Create a digested dictionary for compression\n Dictionary content is just referenced, not duplicated.\n As a consequence, `dictBuffer` **must** outlive CDict,\n and its content must remain unmodified throughout the lifetime of CDict.\n note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef"]
1113 pub fn ZSTD_createCDict_byReference(
1114 dictBuffer: *const ::core::ffi::c_void,
1115 dictSize: usize,
1116 compressionLevel: ::core::ffi::c_int,
1117 ) -> *mut ZSTD_CDict;
1118}
1119extern "C" {
1120 #[doc = " ZSTD_getCParams() :\n @return ZSTD_compressionParameters structure for a selected compression level and estimated srcSize.\n `estimatedSrcSize` value is optional, select 0 if not known"]
1121 pub fn ZSTD_getCParams(
1122 compressionLevel: ::core::ffi::c_int,
1123 estimatedSrcSize: ::core::ffi::c_ulonglong,
1124 dictSize: usize,
1125 ) -> ZSTD_compressionParameters;
1126}
1127extern "C" {
1128 #[doc = " ZSTD_getParams() :\n same as ZSTD_getCParams(), but @return a full `ZSTD_parameters` object instead of sub-component `ZSTD_compressionParameters`.\n All fields of `ZSTD_frameParameters` are set to default : contentSize=1, checksum=0, noDictID=0"]
1129 pub fn ZSTD_getParams(
1130 compressionLevel: ::core::ffi::c_int,
1131 estimatedSrcSize: ::core::ffi::c_ulonglong,
1132 dictSize: usize,
1133 ) -> ZSTD_parameters;
1134}
1135extern "C" {
1136 #[doc = " ZSTD_checkCParams() :\n Ensure param values remain within authorized range.\n @return 0 on success, or an error code (can be checked with ZSTD_isError())"]
1137 pub fn ZSTD_checkCParams(params: ZSTD_compressionParameters) -> usize;
1138}
1139extern "C" {
1140 #[doc = " ZSTD_adjustCParams() :\n optimize params for a given `srcSize` and `dictSize`.\n `srcSize` can be unknown, in which case use ZSTD_CONTENTSIZE_UNKNOWN.\n `dictSize` must be `0` when there is no dictionary.\n cPar can be invalid : all parameters will be clamped within valid range in the @return struct.\n This function never fails (wide contract)"]
1141 pub fn ZSTD_adjustCParams(
1142 cPar: ZSTD_compressionParameters,
1143 srcSize: ::core::ffi::c_ulonglong,
1144 dictSize: usize,
1145 ) -> ZSTD_compressionParameters;
1146}
1147extern "C" {
1148 #[doc = " ZSTD_CCtx_setCParams() :\n Set all parameters provided within @p cparams into the working @p cctx.\n Note : if modifying parameters during compression (MT mode only),\n note that changes to the .windowLog parameter will be ignored.\n @return 0 on success, or an error code (can be checked with ZSTD_isError()).\n On failure, no parameters are updated."]
1149 pub fn ZSTD_CCtx_setCParams(
1150 cctx: *mut ZSTD_CCtx,
1151 cparams: ZSTD_compressionParameters,
1152 ) -> usize;
1153}
1154extern "C" {
1155 #[doc = " ZSTD_CCtx_setFParams() :\n Set all parameters provided within @p fparams into the working @p cctx.\n @return 0 on success, or an error code (can be checked with ZSTD_isError())."]
1156 pub fn ZSTD_CCtx_setFParams(
1157 cctx: *mut ZSTD_CCtx,
1158 fparams: ZSTD_frameParameters,
1159 ) -> usize;
1160}
1161extern "C" {
1162 #[doc = " ZSTD_CCtx_setParams() :\n Set all parameters provided within @p params into the working @p cctx.\n @return 0 on success, or an error code (can be checked with ZSTD_isError())."]
1163 pub fn ZSTD_CCtx_setParams(
1164 cctx: *mut ZSTD_CCtx,
1165 params: ZSTD_parameters,
1166 ) -> usize;
1167}
1168extern "C" {
1169 #[doc = " ZSTD_compress_advanced() :\n Note : this function is now DEPRECATED.\n It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_setParameter() and other parameter setters.\n This prototype will generate compilation warnings."]
1170 pub fn ZSTD_compress_advanced(
1171 cctx: *mut ZSTD_CCtx,
1172 dst: *mut ::core::ffi::c_void,
1173 dstCapacity: usize,
1174 src: *const ::core::ffi::c_void,
1175 srcSize: usize,
1176 dict: *const ::core::ffi::c_void,
1177 dictSize: usize,
1178 params: ZSTD_parameters,
1179 ) -> usize;
1180}
1181extern "C" {
1182 #[doc = " ZSTD_compress_usingCDict_advanced() :\n Note : this function is now DEPRECATED.\n It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_loadDictionary() and other parameter setters.\n This prototype will generate compilation warnings."]
1183 pub fn ZSTD_compress_usingCDict_advanced(
1184 cctx: *mut ZSTD_CCtx,
1185 dst: *mut ::core::ffi::c_void,
1186 dstCapacity: usize,
1187 src: *const ::core::ffi::c_void,
1188 srcSize: usize,
1189 cdict: *const ZSTD_CDict,
1190 fParams: ZSTD_frameParameters,
1191 ) -> usize;
1192}
1193extern "C" {
1194 #[doc = " ZSTD_CCtx_loadDictionary_byReference() :\n Same as ZSTD_CCtx_loadDictionary(), but dictionary content is referenced, instead of being copied into CCtx.\n It saves some memory, but also requires that `dict` outlives its usage within `cctx`"]
1195 pub fn ZSTD_CCtx_loadDictionary_byReference(
1196 cctx: *mut ZSTD_CCtx,
1197 dict: *const ::core::ffi::c_void,
1198 dictSize: usize,
1199 ) -> usize;
1200}
1201extern "C" {
1202 #[doc = " ZSTD_CCtx_loadDictionary_advanced() :\n Same as ZSTD_CCtx_loadDictionary(), but gives finer control over\n how to load the dictionary (by copy ? by reference ?)\n and how to interpret it (automatic ? force raw mode ? full mode only ?)"]
1203 pub fn ZSTD_CCtx_loadDictionary_advanced(
1204 cctx: *mut ZSTD_CCtx,
1205 dict: *const ::core::ffi::c_void,
1206 dictSize: usize,
1207 dictLoadMethod: ZSTD_dictLoadMethod_e,
1208 dictContentType: ZSTD_dictContentType_e,
1209 ) -> usize;
1210}
1211extern "C" {
1212 #[doc = " ZSTD_CCtx_refPrefix_advanced() :\n Same as ZSTD_CCtx_refPrefix(), but gives finer control over\n how to interpret prefix content (automatic ? force raw mode (default) ? full mode only ?)"]
1213 pub fn ZSTD_CCtx_refPrefix_advanced(
1214 cctx: *mut ZSTD_CCtx,
1215 prefix: *const ::core::ffi::c_void,
1216 prefixSize: usize,
1217 dictContentType: ZSTD_dictContentType_e,
1218 ) -> usize;
1219}
1220extern "C" {
1221 #[doc = " ZSTD_CCtx_getParameter() :\n Get the requested compression parameter value, selected by enum ZSTD_cParameter,\n and store it into int* value.\n @return : 0, or an error code (which can be tested with ZSTD_isError())."]
1222 pub fn ZSTD_CCtx_getParameter(
1223 cctx: *const ZSTD_CCtx,
1224 param: ZSTD_cParameter,
1225 value: *mut ::core::ffi::c_int,
1226 ) -> usize;
1227}
1228extern "C" {
1229 #[doc = " ZSTD_CCtx_params :\n Quick howto :\n - ZSTD_createCCtxParams() : Create a ZSTD_CCtx_params structure\n - ZSTD_CCtxParams_setParameter() : Push parameters one by one into\n an existing ZSTD_CCtx_params structure.\n This is similar to\n ZSTD_CCtx_setParameter().\n - ZSTD_CCtx_setParametersUsingCCtxParams() : Apply parameters to\n an existing CCtx.\n These parameters will be applied to\n all subsequent frames.\n - ZSTD_compressStream2() : Do compression using the CCtx.\n - ZSTD_freeCCtxParams() : Free the memory, accept NULL pointer.\n\n This can be used with ZSTD_estimateCCtxSize_advanced_usingCCtxParams()\n for static allocation of CCtx for single-threaded compression."]
1230 pub fn ZSTD_createCCtxParams() -> *mut ZSTD_CCtx_params;
1231}
1232extern "C" {
1233 pub fn ZSTD_freeCCtxParams(params: *mut ZSTD_CCtx_params) -> usize;
1234}
1235extern "C" {
1236 #[doc = " ZSTD_CCtxParams_reset() :\n Reset params to default values."]
1237 pub fn ZSTD_CCtxParams_reset(params: *mut ZSTD_CCtx_params) -> usize;
1238}
1239extern "C" {
1240 #[doc = " ZSTD_CCtxParams_init() :\n Initializes the compression parameters of cctxParams according to\n compression level. All other parameters are reset to their default values."]
1241 pub fn ZSTD_CCtxParams_init(
1242 cctxParams: *mut ZSTD_CCtx_params,
1243 compressionLevel: ::core::ffi::c_int,
1244 ) -> usize;
1245}
1246extern "C" {
1247 #[doc = " ZSTD_CCtxParams_init_advanced() :\n Initializes the compression and frame parameters of cctxParams according to\n params. All other parameters are reset to their default values."]
1248 pub fn ZSTD_CCtxParams_init_advanced(
1249 cctxParams: *mut ZSTD_CCtx_params,
1250 params: ZSTD_parameters,
1251 ) -> usize;
1252}
1253extern "C" {
1254 #[doc = " ZSTD_CCtxParams_setParameter() : Requires v1.4.0+\n Similar to ZSTD_CCtx_setParameter.\n Set one compression parameter, selected by enum ZSTD_cParameter.\n Parameters must be applied to a ZSTD_CCtx using\n ZSTD_CCtx_setParametersUsingCCtxParams().\n @result : a code representing success or failure (which can be tested with\n ZSTD_isError())."]
1255 pub fn ZSTD_CCtxParams_setParameter(
1256 params: *mut ZSTD_CCtx_params,
1257 param: ZSTD_cParameter,
1258 value: ::core::ffi::c_int,
1259 ) -> usize;
1260}
1261extern "C" {
1262 #[doc = " ZSTD_CCtxParams_getParameter() :\n Similar to ZSTD_CCtx_getParameter.\n Get the requested value of one compression parameter, selected by enum ZSTD_cParameter.\n @result : 0, or an error code (which can be tested with ZSTD_isError())."]
1263 pub fn ZSTD_CCtxParams_getParameter(
1264 params: *const ZSTD_CCtx_params,
1265 param: ZSTD_cParameter,
1266 value: *mut ::core::ffi::c_int,
1267 ) -> usize;
1268}
1269extern "C" {
1270 #[doc = " ZSTD_CCtx_setParametersUsingCCtxParams() :\n Apply a set of ZSTD_CCtx_params to the compression context.\n This can be done even after compression is started,\n if nbWorkers==0, this will have no impact until a new compression is started.\n if nbWorkers>=1, new parameters will be picked up at next job,\n with a few restrictions (windowLog, pledgedSrcSize, nbWorkers, jobSize, and overlapLog are not updated)."]
1271 pub fn ZSTD_CCtx_setParametersUsingCCtxParams(
1272 cctx: *mut ZSTD_CCtx,
1273 params: *const ZSTD_CCtx_params,
1274 ) -> usize;
1275}
1276extern "C" {
1277 #[doc = " ZSTD_compressStream2_simpleArgs() :\n Same as ZSTD_compressStream2(),\n but using only integral types as arguments.\n This variant might be helpful for binders from dynamic languages\n which have troubles handling structures containing memory pointers."]
1278 pub fn ZSTD_compressStream2_simpleArgs(
1279 cctx: *mut ZSTD_CCtx,
1280 dst: *mut ::core::ffi::c_void,
1281 dstCapacity: usize,
1282 dstPos: *mut usize,
1283 src: *const ::core::ffi::c_void,
1284 srcSize: usize,
1285 srcPos: *mut usize,
1286 endOp: ZSTD_EndDirective,
1287 ) -> usize;
1288}
1289extern "C" {
1290 #[doc = " ZSTD_isFrame() :\n Tells if the content of `buffer` starts with a valid Frame Identifier.\n Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.\n Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.\n Note 3 : Skippable Frame Identifiers are considered valid."]
1291 pub fn ZSTD_isFrame(
1292 buffer: *const ::core::ffi::c_void,
1293 size: usize,
1294 ) -> ::core::ffi::c_uint;
1295}
1296extern "C" {
1297 #[doc = " ZSTD_createDDict_byReference() :\n Create a digested dictionary, ready to start decompression operation without startup delay.\n Dictionary content is referenced, and therefore stays in dictBuffer.\n It is important that dictBuffer outlives DDict,\n it must remain read accessible throughout the lifetime of DDict"]
1298 pub fn ZSTD_createDDict_byReference(
1299 dictBuffer: *const ::core::ffi::c_void,
1300 dictSize: usize,
1301 ) -> *mut ZSTD_DDict;
1302}
1303extern "C" {
1304 #[doc = " ZSTD_DCtx_loadDictionary_byReference() :\n Same as ZSTD_DCtx_loadDictionary(),\n but references `dict` content instead of copying it into `dctx`.\n This saves memory if `dict` remains around.,\n However, it's imperative that `dict` remains accessible (and unmodified) while being used, so it must outlive decompression."]
1305 pub fn ZSTD_DCtx_loadDictionary_byReference(
1306 dctx: *mut ZSTD_DCtx,
1307 dict: *const ::core::ffi::c_void,
1308 dictSize: usize,
1309 ) -> usize;
1310}
1311extern "C" {
1312 #[doc = " ZSTD_DCtx_loadDictionary_advanced() :\n Same as ZSTD_DCtx_loadDictionary(),\n but gives direct control over\n how to load the dictionary (by copy ? by reference ?)\n and how to interpret it (automatic ? force raw mode ? full mode only ?)."]
1313 pub fn ZSTD_DCtx_loadDictionary_advanced(
1314 dctx: *mut ZSTD_DCtx,
1315 dict: *const ::core::ffi::c_void,
1316 dictSize: usize,
1317 dictLoadMethod: ZSTD_dictLoadMethod_e,
1318 dictContentType: ZSTD_dictContentType_e,
1319 ) -> usize;
1320}
1321extern "C" {
1322 #[doc = " ZSTD_DCtx_refPrefix_advanced() :\n Same as ZSTD_DCtx_refPrefix(), but gives finer control over\n how to interpret prefix content (automatic ? force raw mode (default) ? full mode only ?)"]
1323 pub fn ZSTD_DCtx_refPrefix_advanced(
1324 dctx: *mut ZSTD_DCtx,
1325 prefix: *const ::core::ffi::c_void,
1326 prefixSize: usize,
1327 dictContentType: ZSTD_dictContentType_e,
1328 ) -> usize;
1329}
1330extern "C" {
1331 #[doc = " ZSTD_DCtx_setMaxWindowSize() :\n Refuses allocating internal buffers for frames requiring a window size larger than provided limit.\n This protects a decoder context from reserving too much memory for itself (potential attack scenario).\n This parameter is only useful in streaming mode, since no internal buffer is allocated in single-pass mode.\n By default, a decompression context accepts all window sizes <= (1 << ZSTD_WINDOWLOG_LIMIT_DEFAULT)\n @return : 0, or an error code (which can be tested using ZSTD_isError())."]
1332 pub fn ZSTD_DCtx_setMaxWindowSize(
1333 dctx: *mut ZSTD_DCtx,
1334 maxWindowSize: usize,
1335 ) -> usize;
1336}
1337extern "C" {
1338 #[doc = " ZSTD_DCtx_getParameter() :\n Get the requested decompression parameter value, selected by enum ZSTD_dParameter,\n and store it into int* value.\n @return : 0, or an error code (which can be tested with ZSTD_isError())."]
1339 pub fn ZSTD_DCtx_getParameter(
1340 dctx: *mut ZSTD_DCtx,
1341 param: ZSTD_dParameter,
1342 value: *mut ::core::ffi::c_int,
1343 ) -> usize;
1344}
1345extern "C" {
1346 #[doc = " ZSTD_DCtx_setFormat() :\n This function is REDUNDANT. Prefer ZSTD_DCtx_setParameter().\n Instruct the decoder context about what kind of data to decode next.\n This instruction is mandatory to decode data without a fully-formed header,\n such ZSTD_f_zstd1_magicless for example.\n @return : 0, or an error code (which can be tested using ZSTD_isError())."]
1347 pub fn ZSTD_DCtx_setFormat(
1348 dctx: *mut ZSTD_DCtx,
1349 format: ZSTD_format_e,
1350 ) -> usize;
1351}
1352extern "C" {
1353 #[doc = " ZSTD_decompressStream_simpleArgs() :\n Same as ZSTD_decompressStream(),\n but using only integral types as arguments.\n This can be helpful for binders from dynamic languages\n which have troubles handling structures containing memory pointers."]
1354 pub fn ZSTD_decompressStream_simpleArgs(
1355 dctx: *mut ZSTD_DCtx,
1356 dst: *mut ::core::ffi::c_void,
1357 dstCapacity: usize,
1358 dstPos: *mut usize,
1359 src: *const ::core::ffi::c_void,
1360 srcSize: usize,
1361 srcPos: *mut usize,
1362 ) -> usize;
1363}
1364extern "C" {
1365 #[doc = " ZSTD_initCStream_srcSize() :\n This function is DEPRECATED, and equivalent to:\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)\n ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);\n ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);\n\n pledgedSrcSize must be correct. If it is not known at init time, use\n ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,\n \"0\" also disables frame content size field. It may be enabled in the future.\n This prototype will generate compilation warnings."]
1366 pub fn ZSTD_initCStream_srcSize(
1367 zcs: *mut ZSTD_CStream,
1368 compressionLevel: ::core::ffi::c_int,
1369 pledgedSrcSize: ::core::ffi::c_ulonglong,
1370 ) -> usize;
1371}
1372extern "C" {
1373 #[doc = " ZSTD_initCStream_usingDict() :\n This function is DEPRECATED, and is equivalent to:\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);\n ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);\n\n Creates of an internal CDict (incompatible with static CCtx), except if\n dict == NULL or dictSize < 8, in which case no dict is used.\n Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if\n it begins with ZSTD_MAGIC_DICTIONARY, else as raw content) and ZSTD_dlm_byCopy.\n This prototype will generate compilation warnings."]
1374 pub fn ZSTD_initCStream_usingDict(
1375 zcs: *mut ZSTD_CStream,
1376 dict: *const ::core::ffi::c_void,
1377 dictSize: usize,
1378 compressionLevel: ::core::ffi::c_int,
1379 ) -> usize;
1380}
1381extern "C" {
1382 #[doc = " ZSTD_initCStream_advanced() :\n This function is DEPRECATED, and is equivalent to:\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_setParams(zcs, params);\n ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);\n ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);\n\n dict is loaded with ZSTD_dct_auto and ZSTD_dlm_byCopy.\n pledgedSrcSize must be correct.\n If srcSize is not known at init time, use value ZSTD_CONTENTSIZE_UNKNOWN.\n This prototype will generate compilation warnings."]
1383 pub fn ZSTD_initCStream_advanced(
1384 zcs: *mut ZSTD_CStream,
1385 dict: *const ::core::ffi::c_void,
1386 dictSize: usize,
1387 params: ZSTD_parameters,
1388 pledgedSrcSize: ::core::ffi::c_ulonglong,
1389 ) -> usize;
1390}
1391extern "C" {
1392 #[doc = " ZSTD_initCStream_usingCDict() :\n This function is DEPRECATED, and equivalent to:\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_refCDict(zcs, cdict);\n\n note : cdict will just be referenced, and must outlive compression session\n This prototype will generate compilation warnings."]
1393 pub fn ZSTD_initCStream_usingCDict(
1394 zcs: *mut ZSTD_CStream,
1395 cdict: *const ZSTD_CDict,
1396 ) -> usize;
1397}
1398extern "C" {
1399 #[doc = " ZSTD_initCStream_usingCDict_advanced() :\n This function is DEPRECATED, and is equivalent to:\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_setFParams(zcs, fParams);\n ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);\n ZSTD_CCtx_refCDict(zcs, cdict);\n\n same as ZSTD_initCStream_usingCDict(), with control over frame parameters.\n pledgedSrcSize must be correct. If srcSize is not known at init time, use\n value ZSTD_CONTENTSIZE_UNKNOWN.\n This prototype will generate compilation warnings."]
1400 pub fn ZSTD_initCStream_usingCDict_advanced(
1401 zcs: *mut ZSTD_CStream,
1402 cdict: *const ZSTD_CDict,
1403 fParams: ZSTD_frameParameters,
1404 pledgedSrcSize: ::core::ffi::c_ulonglong,
1405 ) -> usize;
1406}
1407extern "C" {
1408 #[doc = " ZSTD_resetCStream() :\n This function is DEPRECATED, and is equivalent to:\n ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);\n ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);\n Note: ZSTD_resetCStream() interprets pledgedSrcSize == 0 as ZSTD_CONTENTSIZE_UNKNOWN, but\n ZSTD_CCtx_setPledgedSrcSize() does not do the same, so ZSTD_CONTENTSIZE_UNKNOWN must be\n explicitly specified.\n\n start a new frame, using same parameters from previous frame.\n This is typically useful to skip dictionary loading stage, since it will reuse it in-place.\n Note that zcs must be init at least once before using ZSTD_resetCStream().\n If pledgedSrcSize is not known at reset time, use macro ZSTD_CONTENTSIZE_UNKNOWN.\n If pledgedSrcSize > 0, its value must be correct, as it will be written in header, and controlled at the end.\n For the time being, pledgedSrcSize==0 is interpreted as \"srcSize unknown\" for compatibility with older programs,\n but it will change to mean \"empty\" in future version, so use macro ZSTD_CONTENTSIZE_UNKNOWN instead.\n @return : 0, or an error code (which can be tested using ZSTD_isError())\n This prototype will generate compilation warnings."]
1409 pub fn ZSTD_resetCStream(
1410 zcs: *mut ZSTD_CStream,
1411 pledgedSrcSize: ::core::ffi::c_ulonglong,
1412 ) -> usize;
1413}
1414#[repr(C)]
1415#[derive(Debug, Copy, Clone)]
1416pub struct ZSTD_frameProgression {
1417 pub ingested: ::core::ffi::c_ulonglong,
1418 pub consumed: ::core::ffi::c_ulonglong,
1419 pub produced: ::core::ffi::c_ulonglong,
1420 pub flushed: ::core::ffi::c_ulonglong,
1421 pub currentJobID: ::core::ffi::c_uint,
1422 pub nbActiveWorkers: ::core::ffi::c_uint,
1423}
1424extern "C" {
1425 pub fn ZSTD_getFrameProgression(
1426 cctx: *const ZSTD_CCtx,
1427 ) -> ZSTD_frameProgression;
1428}
1429extern "C" {
1430 #[doc = " ZSTD_toFlushNow() :\n Tell how many bytes are ready to be flushed immediately.\n Useful for multithreading scenarios (nbWorkers >= 1).\n Probe the oldest active job, defined as oldest job not yet entirely flushed,\n and check its output buffer.\n @return : amount of data stored in oldest job and ready to be flushed immediately.\n if @return == 0, it means either :\n + there is no active job (could be checked with ZSTD_frameProgression()), or\n + oldest job is still actively compressing data,\n but everything it has produced has also been flushed so far,\n therefore flush speed is limited by production speed of oldest job\n irrespective of the speed of concurrent (and newer) jobs."]
1431 pub fn ZSTD_toFlushNow(cctx: *mut ZSTD_CCtx) -> usize;
1432}
1433extern "C" {
1434 #[doc = " This function is deprecated, and is equivalent to:\n\n ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);\n ZSTD_DCtx_loadDictionary(zds, dict, dictSize);\n\n note: no dictionary will be used if dict == NULL or dictSize < 8"]
1435 pub fn ZSTD_initDStream_usingDict(
1436 zds: *mut ZSTD_DStream,
1437 dict: *const ::core::ffi::c_void,
1438 dictSize: usize,
1439 ) -> usize;
1440}
1441extern "C" {
1442 #[doc = " This function is deprecated, and is equivalent to:\n\n ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);\n ZSTD_DCtx_refDDict(zds, ddict);\n\n note : ddict is referenced, it must outlive decompression session"]
1443 pub fn ZSTD_initDStream_usingDDict(
1444 zds: *mut ZSTD_DStream,
1445 ddict: *const ZSTD_DDict,
1446 ) -> usize;
1447}
1448extern "C" {
1449 #[doc = " This function is deprecated, and is equivalent to:\n\n ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);\n\n reuse decompression parameters from previous init; saves dictionary loading"]
1450 pub fn ZSTD_resetDStream(zds: *mut ZSTD_DStream) -> usize;
1451}
1452pub type ZSTD_sequenceProducer_F = ::core::option::Option<
1453 unsafe extern "C" fn(
1454 sequenceProducerState: *mut ::core::ffi::c_void,
1455 outSeqs: *mut ZSTD_Sequence,
1456 outSeqsCapacity: usize,
1457 src: *const ::core::ffi::c_void,
1458 srcSize: usize,
1459 dict: *const ::core::ffi::c_void,
1460 dictSize: usize,
1461 compressionLevel: ::core::ffi::c_int,
1462 windowSize: usize,
1463 ) -> usize,
1464>;
1465extern "C" {
1466 #[doc = " ZSTD_registerSequenceProducer() :\n Instruct zstd to use a block-level external sequence producer function.\n\n The sequenceProducerState must be initialized by the caller, and the caller is\n responsible for managing its lifetime. This parameter is sticky across\n compressions. It will remain set until the user explicitly resets compression\n parameters.\n\n Sequence producer registration is considered to be an \"advanced parameter\",\n part of the \"advanced API\". This means it will only have an effect on compression\n APIs which respect advanced parameters, such as compress2() and compressStream2().\n Older compression APIs such as compressCCtx(), which predate the introduction of\n \"advanced parameters\", will ignore any external sequence producer setting.\n\n The sequence producer can be \"cleared\" by registering a NULL function pointer. This\n removes all limitations described above in the \"LIMITATIONS\" section of the API docs.\n\n The user is strongly encouraged to read the full API documentation (above) before\n calling this function."]
1467 pub fn ZSTD_registerSequenceProducer(
1468 cctx: *mut ZSTD_CCtx,
1469 sequenceProducerState: *mut ::core::ffi::c_void,
1470 sequenceProducer: ZSTD_sequenceProducer_F,
1471 );
1472}
1473extern "C" {
1474 #[doc = " ZSTD_CCtxParams_registerSequenceProducer() :\n Same as ZSTD_registerSequenceProducer(), but operates on ZSTD_CCtx_params.\n This is used for accurate size estimation with ZSTD_estimateCCtxSize_usingCCtxParams(),\n which is needed when creating a ZSTD_CCtx with ZSTD_initStaticCCtx().\n\n If you are using the external sequence producer API in a scenario where ZSTD_initStaticCCtx()\n is required, then this function is for you. Otherwise, you probably don't need it.\n\n See tests/zstreamtest.c for example usage."]
1475 pub fn ZSTD_CCtxParams_registerSequenceProducer(
1476 params: *mut ZSTD_CCtx_params,
1477 sequenceProducerState: *mut ::core::ffi::c_void,
1478 sequenceProducer: ZSTD_sequenceProducer_F,
1479 );
1480}
1481extern "C" {
1482 #[doc = "Buffer-less streaming compression (synchronous mode)\n\nA ZSTD_CCtx object is required to track streaming operations.\nUse ZSTD_createCCtx() / ZSTD_freeCCtx() to manage resource.\nZSTD_CCtx object can be reused multiple times within successive compression operations.\n\nStart by initializing a context.\nUse ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression.\n\nThen, consume your input using ZSTD_compressContinue().\nThere are some important considerations to keep in mind when using this advanced function :\n- ZSTD_compressContinue() has no internal buffer. It uses externally provided buffers only.\n- Interface is synchronous : input is consumed entirely and produces 1+ compressed blocks.\n- Caller must ensure there is enough space in `dst` to store compressed data under worst case scenario.\nWorst case evaluation is provided by ZSTD_compressBound().\nZSTD_compressContinue() doesn't guarantee recover after a failed compression.\n- ZSTD_compressContinue() presumes prior input ***is still accessible and unmodified*** (up to maximum distance size, see WindowLog).\nIt remembers all previous contiguous blocks, plus one separated memory segment (which can itself consists of multiple contiguous blocks)\n- ZSTD_compressContinue() detects that prior input has been overwritten when `src` buffer overlaps.\nIn which case, it will \"discard\" the relevant memory section from its history.\n\nFinish a frame with ZSTD_compressEnd(), which will write the last block(s) and optional checksum.\nIt's possible to use srcSize==0, in which case, it will write a final empty block to end the frame.\nWithout last block mark, frames are considered unfinished (hence corrupted) by compliant decoders.\n\n`ZSTD_CCtx` object can be reused (ZSTD_compressBegin()) to compress again."]
1483 pub fn ZSTD_compressBegin(
1484 cctx: *mut ZSTD_CCtx,
1485 compressionLevel: ::core::ffi::c_int,
1486 ) -> usize;
1487}
1488extern "C" {
1489 pub fn ZSTD_compressBegin_usingDict(
1490 cctx: *mut ZSTD_CCtx,
1491 dict: *const ::core::ffi::c_void,
1492 dictSize: usize,
1493 compressionLevel: ::core::ffi::c_int,
1494 ) -> usize;
1495}
1496extern "C" {
1497 pub fn ZSTD_compressBegin_usingCDict(
1498 cctx: *mut ZSTD_CCtx,
1499 cdict: *const ZSTD_CDict,
1500 ) -> usize;
1501}
1502extern "C" {
1503 pub fn ZSTD_copyCCtx(
1504 cctx: *mut ZSTD_CCtx,
1505 preparedCCtx: *const ZSTD_CCtx,
1506 pledgedSrcSize: ::core::ffi::c_ulonglong,
1507 ) -> usize;
1508}
1509extern "C" {
1510 pub fn ZSTD_compressContinue(
1511 cctx: *mut ZSTD_CCtx,
1512 dst: *mut ::core::ffi::c_void,
1513 dstCapacity: usize,
1514 src: *const ::core::ffi::c_void,
1515 srcSize: usize,
1516 ) -> usize;
1517}
1518extern "C" {
1519 pub fn ZSTD_compressEnd(
1520 cctx: *mut ZSTD_CCtx,
1521 dst: *mut ::core::ffi::c_void,
1522 dstCapacity: usize,
1523 src: *const ::core::ffi::c_void,
1524 srcSize: usize,
1525 ) -> usize;
1526}
1527extern "C" {
1528 pub fn ZSTD_compressBegin_advanced(
1529 cctx: *mut ZSTD_CCtx,
1530 dict: *const ::core::ffi::c_void,
1531 dictSize: usize,
1532 params: ZSTD_parameters,
1533 pledgedSrcSize: ::core::ffi::c_ulonglong,
1534 ) -> usize;
1535}
1536extern "C" {
1537 pub fn ZSTD_compressBegin_usingCDict_advanced(
1538 cctx: *mut ZSTD_CCtx,
1539 cdict: *const ZSTD_CDict,
1540 fParams: ZSTD_frameParameters,
1541 pledgedSrcSize: ::core::ffi::c_ulonglong,
1542 ) -> usize;
1543}
1544extern "C" {
1545 #[doc = "Buffer-less streaming decompression (synchronous mode)\n\nA ZSTD_DCtx object is required to track streaming operations.\nUse ZSTD_createDCtx() / ZSTD_freeDCtx() to manage it.\nA ZSTD_DCtx object can be reused multiple times.\n\nFirst typical operation is to retrieve frame parameters, using ZSTD_getFrameHeader().\nFrame header is extracted from the beginning of compressed frame, so providing only the frame's beginning is enough.\nData fragment must be large enough to ensure successful decoding.\n`ZSTD_frameHeaderSize_max` bytes is guaranteed to always be large enough.\nresult : 0 : successful decoding, the `ZSTD_frameHeader` structure is correctly filled.\n>0 : `srcSize` is too small, please provide at least result bytes on next attempt.\nerrorCode, which can be tested using ZSTD_isError().\n\nIt fills a ZSTD_FrameHeader structure with important information to correctly decode the frame,\nsuch as the dictionary ID, content size, or maximum back-reference distance (`windowSize`).\nNote that these values could be wrong, either because of data corruption, or because a 3rd party deliberately spoofs false information.\nAs a consequence, check that values remain within valid application range.\nFor example, do not allocate memory blindly, check that `windowSize` is within expectation.\nEach application can set its own limits, depending on local restrictions.\nFor extended interoperability, it is recommended to support `windowSize` of at least 8 MB.\n\nZSTD_decompressContinue() needs previous data blocks during decompression, up to `windowSize` bytes.\nZSTD_decompressContinue() is very sensitive to contiguity,\nif 2 blocks don't follow each other, make sure that either the compressor breaks contiguity at the same place,\nor that previous contiguous segment is large enough to properly handle maximum back-reference distance.\nThere are multiple ways to guarantee this condition.\n\nThe most memory efficient way is to use a round buffer of sufficient size.\nSufficient size is determined by invoking ZSTD_decodingBufferSize_min(),\nwhich can return an error code if required value is too large for current system (in 32-bits mode).\nIn a round buffer methodology, ZSTD_decompressContinue() decompresses each block next to previous one,\nup to the moment there is not enough room left in the buffer to guarantee decoding another full block,\nwhich maximum size is provided in `ZSTD_frameHeader` structure, field `blockSizeMax`.\nAt which point, decoding can resume from the beginning of the buffer.\nNote that already decoded data stored in the buffer should be flushed before being overwritten.\n\nThere are alternatives possible, for example using two or more buffers of size `windowSize` each, though they consume more memory.\n\nFinally, if you control the compression process, you can also ignore all buffer size rules,\nas long as the encoder and decoder progress in \"lock-step\",\naka use exactly the same buffer sizes, break contiguity at the same place, etc.\n\nOnce buffers are setup, start decompression, with ZSTD_decompressBegin().\nIf decompression requires a dictionary, use ZSTD_decompressBegin_usingDict() or ZSTD_decompressBegin_usingDDict().\n\nThen use ZSTD_nextSrcSizeToDecompress() and ZSTD_decompressContinue() alternatively.\nZSTD_nextSrcSizeToDecompress() tells how many bytes to provide as 'srcSize' to ZSTD_decompressContinue().\nZSTD_decompressContinue() requires this _exact_ amount of bytes, or it will fail.\n\nresult of ZSTD_decompressContinue() is the number of bytes regenerated within 'dst' (necessarily <= dstCapacity).\nIt can be zero : it just means ZSTD_decompressContinue() has decoded some metadata item.\nIt can also be an error code, which can be tested with ZSTD_isError().\n\nA frame is fully decoded when ZSTD_nextSrcSizeToDecompress() returns zero.\nContext can then be reset to start a new decompression.\n\nNote : it's possible to know if next input to present is a header or a block, using ZSTD_nextInputType().\nThis information is not required to properly decode a frame.\n\n== Special case : skippable frames ==\n\nSkippable frames allow integration of user-defined data into a flow of concatenated frames.\nSkippable frames will be ignored (skipped) by decompressor.\nThe format of skippable frames is as follows :\na) Skippable frame ID - 4 Bytes, Little endian format, any value from 0x184D2A50 to 0x184D2A5F\nb) Frame Size - 4 Bytes, Little endian format, unsigned 32-bits\nc) Frame Content - any content (User Data) of length equal to Frame Size\nFor skippable frames ZSTD_getFrameHeader() returns zfhPtr->frameType==ZSTD_skippableFrame.\nFor skippable frames ZSTD_decompressContinue() always returns 0 : it only skips the content."]
1546 pub fn ZSTD_decodingBufferSize_min(
1547 windowSize: ::core::ffi::c_ulonglong,
1548 frameContentSize: ::core::ffi::c_ulonglong,
1549 ) -> usize;
1550}
1551extern "C" {
1552 pub fn ZSTD_decompressBegin(dctx: *mut ZSTD_DCtx) -> usize;
1553}
1554extern "C" {
1555 pub fn ZSTD_decompressBegin_usingDict(
1556 dctx: *mut ZSTD_DCtx,
1557 dict: *const ::core::ffi::c_void,
1558 dictSize: usize,
1559 ) -> usize;
1560}
1561extern "C" {
1562 pub fn ZSTD_decompressBegin_usingDDict(
1563 dctx: *mut ZSTD_DCtx,
1564 ddict: *const ZSTD_DDict,
1565 ) -> usize;
1566}
1567extern "C" {
1568 pub fn ZSTD_nextSrcSizeToDecompress(dctx: *mut ZSTD_DCtx) -> usize;
1569}
1570extern "C" {
1571 pub fn ZSTD_decompressContinue(
1572 dctx: *mut ZSTD_DCtx,
1573 dst: *mut ::core::ffi::c_void,
1574 dstCapacity: usize,
1575 src: *const ::core::ffi::c_void,
1576 srcSize: usize,
1577 ) -> usize;
1578}
1579extern "C" {
1580 pub fn ZSTD_copyDCtx(dctx: *mut ZSTD_DCtx, preparedDCtx: *const ZSTD_DCtx);
1581}
1582#[repr(u32)]
1583#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
1584pub enum ZSTD_nextInputType_e {
1585 ZSTDnit_frameHeader = 0,
1586 ZSTDnit_blockHeader = 1,
1587 ZSTDnit_block = 2,
1588 ZSTDnit_lastBlock = 3,
1589 ZSTDnit_checksum = 4,
1590 ZSTDnit_skippableFrame = 5,
1591}
1592extern "C" {
1593 pub fn ZSTD_nextInputType(dctx: *mut ZSTD_DCtx) -> ZSTD_nextInputType_e;
1594}
1595extern "C" {
1596 #[doc = "This API is deprecated in favor of the regular compression API.\nYou can get the frame header down to 2 bytes by setting:\n- ZSTD_c_format = ZSTD_f_zstd1_magicless\n- ZSTD_c_contentSizeFlag = 0\n- ZSTD_c_checksumFlag = 0\n- ZSTD_c_dictIDFlag = 0\n\nThis API is not as well tested as our normal API, so we recommend not using it.\nWe will be removing it in a future version. If the normal API doesn't provide\nthe functionality you need, please open a GitHub issue.\n\nBlock functions produce and decode raw zstd blocks, without frame metadata.\nFrame metadata cost is typically ~12 bytes, which can be non-negligible for very small blocks (< 100 bytes).\nBut users will have to take in charge needed metadata to regenerate data, such as compressed and content sizes.\n\nA few rules to respect :\n- Compressing and decompressing require a context structure\n+ Use ZSTD_createCCtx() and ZSTD_createDCtx()\n- It is necessary to init context before starting\n+ compression : any ZSTD_compressBegin*() variant, including with dictionary\n+ decompression : any ZSTD_decompressBegin*() variant, including with dictionary\n- Block size is limited, it must be <= ZSTD_getBlockSize() <= ZSTD_BLOCKSIZE_MAX == 128 KB\n+ If input is larger than a block size, it's necessary to split input data into multiple blocks\n+ For inputs larger than a single block, consider using regular ZSTD_compress() instead.\nFrame metadata is not that costly, and quickly becomes negligible as source size grows larger than a block.\n- When a block is considered not compressible enough, ZSTD_compressBlock() result will be 0 (zero) !\n===> In which case, nothing is produced into `dst` !\n+ User __must__ test for such outcome and deal directly with uncompressed data\n+ A block cannot be declared incompressible if ZSTD_compressBlock() return value was != 0.\nDoing so would mess up with statistics history, leading to potential data corruption.\n+ ZSTD_decompressBlock() _doesn't accept uncompressed data as input_ !!\n+ In case of multiple successive blocks, should some of them be uncompressed,\ndecoder must be informed of their existence in order to follow proper history.\nUse ZSTD_insertBlock() for such a case."]
1597 pub fn ZSTD_getBlockSize(cctx: *const ZSTD_CCtx) -> usize;
1598}
1599extern "C" {
1600 pub fn ZSTD_compressBlock(
1601 cctx: *mut ZSTD_CCtx,
1602 dst: *mut ::core::ffi::c_void,
1603 dstCapacity: usize,
1604 src: *const ::core::ffi::c_void,
1605 srcSize: usize,
1606 ) -> usize;
1607}
1608extern "C" {
1609 pub fn ZSTD_decompressBlock(
1610 dctx: *mut ZSTD_DCtx,
1611 dst: *mut ::core::ffi::c_void,
1612 dstCapacity: usize,
1613 src: *const ::core::ffi::c_void,
1614 srcSize: usize,
1615 ) -> usize;
1616}
1617extern "C" {
1618 pub fn ZSTD_insertBlock(
1619 dctx: *mut ZSTD_DCtx,
1620 blockStart: *const ::core::ffi::c_void,
1621 blockSize: usize,
1622 ) -> usize;
1623}