Lines Matching full:note
106 note 1 : a 0 return value means the frame is valid but "empty".
107 …note 2 : decompressed size is an optional field, it may not be present, typically in streaming mod…
113 …note 3 : decompressed size is always present when compression is completed using single-pass funct…
115 note 4 : decompressed size can be very large (64-bits value),
118 note 5 : If source is untrusted, decompressed size could be wrong or intentionally modified.
121 note 6 : This function replaces ZSTD_getDecompressedSize()
125 </b><p> NOTE: This function is now obsolete, in favor of ZSTD_getFrameContentSize().
154 Note : re-using context is just a speed / resource optimization.
156 Note 2 : In multi-threaded environments,
205 </b>/* note : new strategies _might_ be added in the future.<b>
212 * Note: When compressing with a ZSTD_CDict these parameters are superseded
216 * Note that exact compression parameters are dynamically determined,
220 * Note 1 : it's possible to pass a negative compression level.
221 … * Note 2 : setting a level does not automatically set all other compression parameters
234 * Note: Using a windowLog greater than ZSTD_WINDOWLOG_LIMIT_DEFAULT
255 * Note that Zstandard can still find matches of smaller size,
259 … * Note that currently, for all strategies < btopt, effective minimum is 4.
279 … * Note: enabling this parameter increases default ZSTD_c_windowLog to 128 MB
281 … * Note: will be enabled by default if ZSTD_c_windowLog >= 128 MB and
322 …* (note : a strong exception to this rule is when first invocation of ZSTD_compressStream2() sets …
345 </b>/* note : additional experimental parameters are also available<b>
363 * note : never ever use experimentalParam? names directly;
416 Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.
419 Note 2 : pledgedSrcSize is only valid once, for the next frame.
421 Note 3 : Whenever all input data is provided and consumed in a single round,
475 </b>/* note : additional experimental parameters are also available<b>
483 * note : never ever use experimentalParam? names directly
540 note : since v1.3.0, ZSTD_CStream and ZSTD_CCtx are the same thing.
552 Note that the function may not consume the entire input, for example, because
557 note: ZSTD_e_continue is guaranteed to make some forward progress when called,
567 …Note that, if `output->size` is too small, a single invocation with ZSTD_e_flush might not be enou…
571 …note: ZSTD_e_flush will flush as much output as possible, meaning when compressing with multiple t…
583 …note: ZSTD_e_end will flush as much output as possible, meaning when compressing with multiple thr…
602 … * note : multithreaded compression will block to flush as much output as possible. */
604 … * note that frame is only closed after compressed data is fully flushed (return value == 0).
606 … * note : each frame is independent (does not reference any content from previous frame).
607 … : note : multithreaded compression will block to flush as much output as possible. */
644 * NOTE: The return value is different. ZSTD_compressStream() returns a hint for
677 …Note : with no additional input provided, amount of data flushed is necessarily <= ZSTD_BLOCKSIZE_…
706 Note : This function loads the dictionary, resulting in significant startup delay.
708 Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used.
717 Note : This function loads the dictionary, resulting in significant startup delay.
719 Note : When `dict == NULL || dictSize < 8` no dictionary is used.
732 …Note 1 : Consider experimental function `ZSTD_createCDict_byReference()` if you prefer to not dupl…
733 Note 2 : A ZSTD_CDict can be created from an empty @dictBuffer,
750 Note : compression level is _decided at dictionary creation time_,
798 Note : this use case also happens when using a non-conformant dictionary.
817 Note 1 : Dictionary is sticky, it will be used for all future compressed frames.
819 Note 2 : Loading a dictionary involves building tables.
823 Note 3 :`dict` content will be copied internally.
826 Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()
832 Note that compression parameters are enforced from within CDict,
839 Note 1 : Currently, only one dictionary can be managed.
841 Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx.
853 Note 1 : Prefix buffer is referenced. It **must** outlive compression.
855 Note 2 : If the intention is to diff some large src data blob with some prior version of itself,
858 …Note 3 : Referencing a prefix involves building tables, which are dependent on compression paramet…
861 Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dct_rawContent).
872 Note 1 : Loading a dictionary involves building tables,
875 Note 2 :`dict` content will be copied internally, so `dict` can be released after loading.
877 Note 3 : Use ZSTD_DCtx_loadDictionary_advanced() to take control of
893 Note 1 : Currently, only one dictionary can be managed.
896 Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx.
908 Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary
909 Note 2 : Prefix buffer is referenced. It **must** outlive decompression.
912 Note 3 : By default, the prefix is treated as raw content (ZSTD_dct_rawContent).
914 Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost.
926 Note that object memory usage can evolve (increase or decrease) over time.
947 …</b>/* Note: Users of this API may provide a sequence with matchLength == litLength == offset == 0…
968 … * Note: This field is optional. ZSTD_generateSequences() will calculate the value of
1015 </b>/* Note: this enum controls ZSTD_d_forceIgnoreChecksum */<b>
1021 </b>/* Note: this enum controls ZSTD_d_refMultipleDDicts */<b>
1027 </b>/* Note: this enum and the behavior it controls are effectively internal<b>
1075 …</b>/* Note: This enum controls features which are conditionally beneficial. Zstd typically will m…
1094 …note 1 : decompressed size is an optional field, that may not be present, especially in streaming …
1097 note 2 : decompressed size is always present when compression is done with ZSTD_compress()
1098 note 3 : decompressed size can be very large (64-bits value),
1101 note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
1104 note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input to
1116 note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1117 …note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD enc…
1119 …note 3 : when the decompressed size field isn't available, the upper-bound for that frame is calc…
1189 …Note: Repcodes are, as of now, always re-calculated within this function, so ZSTD_Sequence::rep is…
1190 …Note 2: Once we integrate ability to ingest repcodes, the explicit block delims mode must respect …
1242 Note : Unlike ZSTD_estimateCStreamSize*(), this estimate
1256 Note 2 : only single-threaded compression is supported.
1271 Note : CStream size estimation is only correct for single-threaded compression.
1275 Note : if streaming is init with function ZSTD_init?Stream_usingDict(),
1285 Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller.
1299 Note : zstd will never resize nor malloc() when using a static buffer.
1302 Note 2 : there is no corresponding "free" function.
1304 Note 3 : cParams : use ZSTD_getCParams() to convert a compression level
1337 Note that the lifetime of such pool must exist while being used.
1351 note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef
1383 </b><p> Note : this function is now DEPRECATED.
1394 </b><p> Note : this function is now DEPRECATED.
1502 Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
1503 Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
1504 Note 3 : Skippable Frame Identifiers are considered valid.
1586 ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
1603 Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
1636 note : cdict will just be referenced, and must outlive compression session
1667 Note: ZSTD_resetCStream() interprets pledgedSrcSize == 0 as ZSTD_CONTENTSIZE_UNKNOWN, but
1673 Note that zcs must be init at least once before using ZSTD_resetCStream().
1713 note: no dictionary will be used if dict == NULL or dictSize < 8
1714 …Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v…
1723 note : ddict is referenced, it must outlive decompression session
1724 …Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v…
1733 …Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v…
1774 …pressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); </b>/**< note: fails if cdict==NU…
1775 …st ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); </b>/**< note: if pledgedSrcSize …
1794 …Note that these values could be wrong, either because of data corruption, or because a 3rd party d…
1813 Note that already decoded data stored in the buffer should be flushed before being overwritten.
1835 …Note : it's possible to know if next input to present is a header or a block, using ZSTD_nextInput…