Lines Matching full:note
136 * note 1 : a 0 return value means the frame is valid but "empty".
137 …* note 2 : decompressed size is an optional field, it may not be present, typically in streaming…
143 …* note 3 : decompressed size is always present when compression is completed using single-pass f…
145 * note 4 : decompressed size can be very large (64-bits value),
148 * note 5 : If source is untrusted, decompressed size could be wrong or intentionally modified.
151 * note 6 : This function replaces ZSTD_getDecompressedSize() */
157 * NOTE: This function is now obsolete, in favor of ZSTD_getFrameContentSize().
190 * Note : re-using context is just a speed / resource optimization.
192 * Note 2 : In multi-threaded environments,
260 /* note : new strategies _might_ be added in the future.
268 * Note: When compressing with a ZSTD_CDict these parameters are superseded
272 * Note that exact compression parameters are dynamically determined,
276 * Note 1 : it's possible to pass a negative compression level.
277 … * Note 2 : setting a level does not automatically set all other compression parameters
290 * Note: Using a windowLog greater than ZSTD_WINDOWLOG_LIMIT_DEFAULT
311 * Note that Zstandard can still find matches of smaller size,
315 … * Note that currently, for all strategies < btopt, effective minimum is 4.
336 … * Note: enabling this parameter increases default ZSTD_c_windowLog to 128 MB
374 …* (note : a strong exception to this rule is when first invocation of ZSTD_compressStream2() sets …
396 /* note : additional experimental parameters are also available
407 * note : never ever use experimentalParam? names directly;
452 * Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.
455 * Note 2 : pledgedSrcSize is only valid once, for the next frame.
457 * Note 3 : Whenever all input data is provided and consumed in a single round,
509 * Note : This API is compatible with existing ZSTD_decompressDCtx() and ZSTD_decompressStream().
522 /* note : additional experimental parameters are also available
528 * note : never ever use experimentalParam? names directly
590 * note : since v1.3.0, ZSTD_CStream and ZSTD_CCtx are the same thing.
602 * Note that the function may not consume the entire input, for example, because
607 * note: ZSTD_e_continue is guaranteed to make some forward progress when called,
617 * Note that, if `output->size` is too small, a single invocation with ZSTD_e_flush might not be en…
621 * note: ZSTD_e_flush will flush as much output as possible, meaning when compressing with multiple…
633 * note: ZSTD_e_end will flush as much output as possible, meaning when compressing with multiple t…
653 … * note : multithreaded compression will block to flush as much output as possible. */
655 … * note that frame is only closed after compressed data is fully flushed (return value == 0).
657 … * note : each frame is independent (does not reference any content from previous frame).
658 … : note : multithreaded compression will block to flush as much output as possible. */
693 * However, note that these recommendations are from the perspective of a C caller program.
723 * NOTE: The return value is different. ZSTD_compressStream() returns a hint for
753 * Note : with no additional input provided, amount of data flushed is necessarily <= ZSTD_BLOCKSIZ…
789 * Note : This function loads the dictionary, resulting in significant startup delay.
791 * Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used. */
801 * Note : This function loads the dictionary, resulting in significant startup delay.
803 * Note : When `dict == NULL || dictSize < 8` no dictionary is used. */
822 …* Note 1 : Consider experimental function `ZSTD_createCDict_byReference()` if you prefer to not d…
823 * Note 2 : A ZSTD_CDict can be created from an empty @dictBuffer,
837 * Note : compression level is _decided at dictionary creation time_,
887 * Note : this use case also happens when using a non-conformant dictionary.
910 * Note 1 : Dictionary is sticky, it will be used for all future compressed frames.
912 * Note 2 : Loading a dictionary involves building tables.
916 * Note 3 :`dict` content will be copied internally.
919 * Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()
925 * Note that compression parameters are enforced from within CDict,
932 * Note 1 : Currently, only one dictionary can be managed.
934 * Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. */
945 * Note 1 : Prefix buffer is referenced. It **must** outlive compression.
947 * Note 2 : If the intention is to diff some large src data blob with some prior version of itself,
950 …* Note 3 : Referencing a prefix involves building tables, which are dependent on compression para…
953 * Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dct_rawContent).
965 * Note 1 : Loading a dictionary involves building tables,
968 * Note 2 :`dict` content will be copied internally, so `dict` can be released after loading.
970 * Note 3 : Use ZSTD_DCtx_loadDictionary_advanced() to take control of
979 * Note 1 : Currently, only one dictionary can be managed.
982 * Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx.
993 * Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary
994 * Note 2 : Prefix buffer is referenced. It **must** outlive decompression.
997 * Note 3 : By default, the prefix is treated as raw content (ZSTD_dct_rawContent).
999 * Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost.
1009 * Note that object memory usage can evolve (increase or decrease) over time. */
1063 #define ZSTD_TARGETLENGTH_MIN 0 /* note : comparing this constant to an unsigned results in a…
1160 /* Note: this enum and the behavior it controls are effectively internal
1220 …* note 1 : decompressed size is an optional field, that may not be present, especially in stream…
1223 * note 2 : decompressed size is always present when compression is done with ZSTD_compress()
1224 * note 3 : decompressed size can be very large (64-bits value),
1227 * note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
1230 …* note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input …
1242 * note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1243 …* note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD …
1245 …* note 3 : when the decompressed size field isn't available, the upper-bound for that frame is c…
1276 * Note : Unlike ZSTD_estimateCStreamSize*(), this estimate
1290 * Note 2 : only single-threaded compression is supported.
1304 * Note : CStream size estimation is only correct for single-threaded compression.
1308 * Note : if streaming is init with function ZSTD_init?Stream_usingDict(),
1320 * Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller.
1335 * Note : zstd will never resize nor malloc() when using a static buffer.
1338 * Note 2 : there is no corresponding "free" function.
1340 * Note 3 : cParams : use ZSTD_getCParams() to convert a compression level
1404 * note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef */
1431 * Note : this function is now DEPRECATED.
1441 * Note : this function is now REDUNDANT.
1479 * NOTE 1: rsyncable mode only works when multithreading is enabled.
1480 * NOTE 2: rsyncable performs poorly in combination with long range mode,
1483 * NOTE 3: Rsyncable mode limits maximum compression speed to ~400 MB/s.
1610 * Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
1611 * Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
1612 * Note 3 : Skippable Frame Identifiers are considered valid. */
1675 * NOTE: So long as the ZSTD_outBuffer always points to valid memory, using
1722 * ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
1724 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1739 * Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
1741 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1761 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1774 * note : cdict will just be referenced, and must outlive compression session
1775 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1792 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1807 * Note that zcs must be init at least once before using ZSTD_resetCStream().
1813 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reachin…
1830 * Note : (ingested - consumed) is amount of input data buffered internally, not yet compressed.
1858 * note: no dictionary will be used if dict == NULL or dictSize < 8
1859 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1869 * note : ddict is referenced, it must outlive decompression session
1870 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1880 …* Note : this prototype will be marked as deprecated and generate compilation warnings on reaching…
1928 …_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /**< note: fails if cdict==NU…
1930 … const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); /**< note: if pledgedSrcSize …
1953 …Note that these values could be wrong, either because of data corruption, or because a 3rd party d…
1972 Note that already decoded data stored in the buffer should be flushed before being overwritten.
1994 …Note : it's possible to know if next input to present is a header or a block, using ZSTD_nextInput…