Lines Matching full:a
9 <a name="Contents"></a><h2>Contents</h2>
11 <li><a href="#Chapter1">Introduction</a></li>
12 <li><a href="#Chapter2">Version</a></li>
13 <li><a href="#Chapter3">Tuning parameter</a></li>
14 <li><a href="#Chapter4">Simple Functions</a></li>
15 <li><a href="#Chapter5">Advanced Functions</a></li>
16 <li><a href="#Chapter6">Streaming Compression Functions</a></li>
17 <li><a href="#Chapter7">Streaming Decompression Functions</a></li>
18 <li><a href="#Chapter8">Experimental section</a></li>
19 <li><a href="#Chapter9">Private Definitions</a></li>
20 <li><a href="#Chapter10">Obsolete Functions</a></li>
23 <a name="Chapter1"></a><h2>Introduction</h2><pre>
31 - a single step (described as Simple Functions)
32 - a single step, reusing a context (described in Advanced Functions)
36 Decompressing such a compressed block requires additional metadata.
45 Frames bundle both blocks and metadata in a specified manner.
47 Frame format is delivered through a companion API, declared in lz4frame.h.
51 <a name="Chapter2"></a><h2>Version</h2><pre></pre>
57 <a name="Chapter3"></a><h2>Tuning parameter</h2><pre></pre>
69 <a name="Chapter4"></a><h2>Simple Functions</h2><pre></pre>
75 It also runs faster, so it's a recommended setting.
76 If the function cannot compress 'src' into a more limited 'dst' budget,
92 …If the source stream is detected malformed, the function will stop decoding and return a negative …
99 …If there is a need for a different format which bundles together both compressed data and its meta…
103 <a name="Chapter5"></a><h2>Advanced Functions</h2><pre></pre>
106 </b><p> Provides the maximum size that LZ4 compression may output in a "worst case" scenario (in…
111 return : maximum output size in a "worst case" scenario
118 …It's a trade-off. It can be fine tuned, with each successive value providing roughly +~3% to speed.
145 Note : from v1.8.2 to v1.9.1, this function had a bug (fixed un v1.9.2+):
147 require to be decompressed into a destination buffer larger
153 a dstCapacity which is > decompressedSize, by at least 1 byte.
164 whenever only the beginning of a block is required.
167 If source stream is detected malformed, function returns a negative result.
194 <a name="Chapter6"></a><h2>Streaming Compression Functions</h2><pre></pre>
197 </b><p> Use this to prepare an LZ4_stream_t for a new chain of dependent blocks
206 A same LZ4_stream_t can be re-used multiple times consecutively
221 </b><p> Use this function to reference a static dictionary into LZ4_stream_t.
223 LZ4_loadDict() triggers a reset, so any previous data will be forgotten.
228 Loading a size of 0 is allowed, and is the same as reset.
241 Note 1 : Each invocation to LZ4_compress_fast_continue() generates a new block.
244 …It's not possible to append blocks together and expect a single invocation of LZ4_decompress_*() t…
248 …Note 3 : When input is structured as a double-buffer, each buffer can have any size, including < 6…
252 Note 4 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.
260 save it into a safer place (char* safeBuffer).
261 This is schematically equivalent to a memcpy() followed by LZ4_loadDict(),
267 <a name="Chapter7"></a><h2>Streaming Decompression Functions</h2><pre> Bufferless synchronous API
273 A tracking context can be re-used multiple times.
279 Use this function to start decompression of a new stream of blocks.
280 A dictionary can optionally be set. Use NULL or size 0 for a reset order.
288 </b><p> Note : in a ring buffer scenario (optional),
292 When setting such a ring buffer for streaming decompression,
302 A block is an unsplittable entity, it must be presented entirely to a decompression function.
303 Decompression functions only accepts one block at a time.
307 …Special : if decompression side sets a ring buffer, it must respect one of the following condition…
317 - Decompression buffer is larger than encoding buffer, by a minimum of maxBlockSize more bytes.
322 …save the last 64KB of decoded data into a safe buffer where it can't be modified during decompress…
328 a combination of LZ4_setStreamDecode() followed by LZ4_decompress_*_continue()
336 <a name="Chapter8"></a><h2>Experimental section</h2><pre>
344 when building LZ4 as a shared/dynamic library.
355 </b><p> A variant of LZ4_compress_fast_extState().
359 (see above comment on LZ4_resetStream_fast() for a definition of "correctly initialized").
360 From a high level, the difference is that
361 this function initializes the provided state with a call to something like LZ4_resetStream_fast()
362 while LZ4_compress_fast_extState() starts with a call to LZ4_resetStream().
368 efficient use of a static dictionary many times.
370 Rather than re-loading the dictionary buffer into a working context before
371 each compression, or copying a pre-loaded dictionary's LZ4_stream_t into a
372 working LZ4_stream_t, this function introduces a no-copy setup mechanism,
382 If a dictionary is provided, it replaces any pre-existing stream history.
414 and it would be more efficient to store such data with a flag indicating it's not compressed.
420 As a consequence, buffer size requirements are much higher,
425 Note that it is a compile-time constant, so all compressions will apply this limit.
427 so it's a reasonable trick when inputs are known to be small.
428 - Require the compressor to deliver a "maximum compressed size".
433 and typically design a backup scheme to send data uncompressed.
445 …umes that compressedSize < decompressedSize. note2: margin is overestimated a bit, since it could …
449 <a name="Chapter9"></a><h2>Private Definitions</h2><pre>
484 Use LZ4_initStream() to properly initialize a newly declared LZ4_stream_t.
486 and will @return a pointer of proper type upon initialization.
505 and may change in a future version !
509 <a name="Chapter10"></a><h2>Obsolete Functions</h2><pre></pre>
528 Deprecated functions make the compiler generate a warning when invoked.
530 Should deprecation warnings be a problem, it is generally possible to disable them,
565 …compress_fast()` is not protected vs malformed or malicious inputs, making it a security liability.
566 As a consequence, LZ4_decompress_fast() is strongly discouraged, and deprecated.
569 it can decompress a block without knowing its compressed size.
570 Such functionality can be achieved in a more secure manner
578 …If the source stream is detected malformed, the function stops decoding and returns a negative res…
584 As a consequence, use these functions in trusted environments with trusted data **only**.