Lines Matching full:note
126 * note 1 : a 0 return value means the frame is valid but "empty".
127 …* note 2 : decompressed size is an optional field, it may not be present, typically in streaming…
133 …* note 3 : decompressed size is always present when compression is completed using single-pass f…
135 * note 4 : decompressed size can be very large (64-bits value),
138 * note 5 : If source is untrusted, decompressed size could be wrong or intentionally modified.
141 * note 6 : This function replaces ZSTD_getDecompressedSize() */
147 * NOTE: This function is now obsolete, in favor of ZSTD_getFrameContentSize().
180 * Note : re-using context is just a speed / resource optimization.
182 * Note 2 : In multi-threaded environments,
250 /* note : new strategies _might_ be added in the future.
258 * Note: When compressing with a ZSTD_CDict these parameters are superseded
262 * Note that exact compression parameters are dynamically determined,
266 * Note 1 : it's possible to pass a negative compression level.
267 … * Note 2 : setting a level does not automatically set all other compression parameters
280 * Note: Using a windowLog greater than ZSTD_WINDOWLOG_LIMIT_DEFAULT
301 * Note that Zstandard can still find matches of smaller size,
305 … * Note that currently, for all strategies < btopt, effective minimum is 4.
326 … * Note: enabling this parameter increases default ZSTD_c_windowLog to 128 MB
328 … * Note: will be enabled by default if ZSTD_c_windowLog >= 128 MB and
369 …* (note : a strong exception to this rule is when first invocation of ZSTD_compressStream2() sets …
392 /* note : additional experimental parameters are also available
408 * note : never ever use experimentalParam? names directly;
458 * Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.
461 * Note 2 : pledgedSrcSize is only valid once, for the next frame.
463 * Note 3 : Whenever all input data is provided and consumed in a single round,
515 * Note : This API is compatible with existing ZSTD_decompressDCtx() and ZSTD_decompressStream().
528 /* note : additional experimental parameters are also available
536 * note : never ever use experimentalParam? names directly
600 * note : since v1.3.0, ZSTD_CStream and ZSTD_CCtx are the same thing.
612 * Note that the function may not consume the entire input, for example, because
617 * note: ZSTD_e_continue is guaranteed to make some forward progress when called,
627 * Note that, if `output->size` is too small, a single invocation with ZSTD_e_flush might not be en…
631 * note: ZSTD_e_flush will flush as much output as possible, meaning when compressing with multiple…
643 * note: ZSTD_e_end will flush as much output as possible, meaning when compressing with multiple t…
663 … * note : multithreaded compression will block to flush as much output as possible. */
665 … * note that frame is only closed after compressed data is fully flushed (return value == 0).
667 … * note : each frame is independent (does not reference any content from previous frame).
668 … : note : multithreaded compression will block to flush as much output as possible. */
704 * However, note that these recommendations are from the perspective of a C caller program.
734 * NOTE: The return value is different. ZSTD_compressStream() returns a hint for
764 * Note : with no additional input provided, amount of data flushed is necessarily <= ZSTD_BLOCKSIZ…
800 * Note : This function loads the dictionary, resulting in significant startup delay.
802 * Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used. */
812 * Note : This function loads the dictionary, resulting in significant startup delay.
814 * Note : When `dict == NULL || dictSize < 8` no dictionary is used. */
833 …* Note 1 : Consider experimental function `ZSTD_createCDict_byReference()` if you prefer to not d…
834 * Note 2 : A ZSTD_CDict can be created from an empty @dictBuffer,
849 * Note : compression level is _decided at dictionary creation time_,
900 * Note : this use case also happens when using a non-conformant dictionary.
923 * Note 1 : Dictionary is sticky, it will be used for all future compressed frames.
925 * Note 2 : Loading a dictionary involves building tables.
929 * Note 3 :`dict` content will be copied internally.
932 * Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()
938 * Note that compression parameters are enforced from within CDict,
945 * Note 1 : Currently, only one dictionary can be managed.
947 * Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. */
958 * Note 1 : Prefix buffer is referenced. It **must** outlive compression.
960 * Note 2 : If the intention is to diff some large src data blob with some prior version of itself,
963 …* Note 3 : Referencing a prefix involves building tables, which are dependent on compression para…
966 * Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dct_rawContent).
978 * Note 1 : Loading a dictionary involves building tables,
981 * Note 2 :`dict` content will be copied internally, so `dict` can be released after loading.
983 * Note 3 : Use ZSTD_DCtx_loadDictionary_advanced() to take control of
999 * Note 1 : Currently, only one dictionary can be managed.
1002 * Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx.
1013 * Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary
1014 * Note 2 : Prefix buffer is referenced. It **must** outlive decompression.
1017 * Note 3 : By default, the prefix is treated as raw content (ZSTD_dct_rawContent).
1019 * Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost.
1029 * Note that object memory usage can evolve (increase or decrease) over time. */
1083 #define ZSTD_TARGETLENGTH_MIN 0 /* note : comparing this constant to an unsigned results in a…
1131 … /* Note: Users of this API may provide a sequence with matchLength == litLength == offset == 0.
1152 … * Note: This field is optional. ZSTD_generateSequences() will calculate the value of
1199 /* Note: this enum controls ZSTD_d_forceIgnoreChecksum */
1205 /* Note: this enum controls ZSTD_d_refMultipleDDicts */
1211 /* Note: this enum and the behavior it controls are effectively internal
1271 …* note 1 : decompressed size is an optional field, that may not be present, especially in stream…
1274 * note 2 : decompressed size is always present when compression is done with ZSTD_compress()
1275 * note 3 : decompressed size can be very large (64-bits value),
1278 * note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
1281 …* note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input …
1293 * note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1294 …* note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD …
1296 …* note 3 : when the decompressed size field isn't available, the upper-bound for that frame is c…
1367 …* Note: Repcodes are, as of now, always re-calculated within this function, so ZSTD_Sequence::rep …
1368 …* Note 2: Once we integrate ability to ingest repcodes, the explicit block delims mode must respec…
1404 * Note : Unlike ZSTD_estimateCStreamSize*(), this estimate
1418 * Note 2 : only single-threaded compression is supported.
1432 * Note : CStream size estimation is only correct for single-threaded compression.
1436 * Note : if streaming is init with function ZSTD_init?Stream_usingDict(),
1448 * Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller.
1463 * Note : zstd will never resize nor malloc() when using a static buffer.
1466 * Note 2 : there is no corresponding "free" function.
1468 * Note 3 : cParams : use ZSTD_getCParams() to convert a compression level
1523 * Note that the lifetime of such pool must exist while being used.
1560 * note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef */
1593 * Note : this function is now DEPRECATED.
1603 * Note : this function is now REDUNDANT.
1641 * NOTE 1: rsyncable mode only works when multithreading is enabled.
1642 * NOTE 2: rsyncable performs poorly in combination with long range mode,
1645 * NOTE 3: Rsyncable mode limits maximum compression speed to ~400 MB/s.
1717 * Note that some of the members of the ZSTD_compressionParameters struct have
1729 * Note that this means that the CDict tables can no longer be copied into the
1757 * NOTE: ZSTD_compressStream2() will error if ZSTD_e_end is not used.
1760 * NOTE: So long as the ZSTD_inBuffer always points to valid memory, using
1911 * Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
1912 * Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
1913 * Note 3 : Skippable Frame Identifiers are considered valid. */
1983 * NOTE: So long as the ZSTD_outBuffer always points to valid memory, using
2066 * ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
2068 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2083 * Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
2085 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2105 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2118 * note : cdict will just be referenced, and must outlive compression session
2119 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2136 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2151 * Note that zcs must be init at least once before using ZSTD_resetCStream().
2157 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reachin…
2174 * Note : (ingested - consumed) is amount of input data buffered internally, not yet compressed.
2203 * note: no dictionary will be used if dict == NULL or dictSize < 8
2204 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2214 * note : ddict is referenced, it must outlive decompression session
2215 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2225 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
2273 …D_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /*< note: fails if cdict==NU…
2275 …, const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); /*< note: if pledgedSrcSize …
2298 …Note that these values could be wrong, either because of data corruption, or because a 3rd party d…
2317 Note that already decoded data stored in the buffer should be flushed before being overwritten.
2339 …Note : it's possible to know if next input to present is a header or a block, using ZSTD_nextInput…