Enum FlushCompress

Variants

None = { _ }

A typical parameter for passing to compression/decompression functions, this indicates that the underlying stream to decide how much data to accumulate before producing output in order to maximize compression.

Partial = { _ }

All pending output is flushed to the output buffer, but the output is not aligned to a byte boundary.

All input data so far will be available to the decompressor (as with Flush::Sync). This completes the current deflate block and follows it with an empty fixed codes block that is 10 bits long, and it assures that enough bytes are output in order for the decompressor to finish the block before the empty fixed code block.

Sync = { _ }

All pending output is flushed to the output buffer and the output is aligned on a byte boundary so that the decompressor can get all input data available so far.

Flushing may degrade compression for some compression algorithms and so it should only be used when necessary. This will complete the current deflate block and follow it with an empty stored block.

Full = { _ }

All output is flushed as with Flush::Sync and the compression state is reset so decompression can restart from this point if previous compressed data has been damaged or if random access is desired.

Using this option too often can seriously degrade compression.

Finish = { _ }

Pending input is processed and pending output is flushed.

The return value may indicate that the stream is not yet done and more data has yet to be processed.