Enum flate2::FlushCompress

#[non_exhaustive]
pub enum FlushCompress {
    None = 0,
    Sync = 2,
    Partial = 1,
    Full = 3,
    Finish = 4,
}

Values which indicate the form of flushing to be used when compressing in-memory data.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None = 0

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.

Sync = 2

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.

Partial = 1

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

All of the 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 bites long, and it assures that enough bytes are output in order for the decompressor to finish the block before the empty fixed code block.

Full = 3

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 = 4

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.

Trait Implementations

impl Clone for FlushCompress

fn clone(&self) -> FlushCompress

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlushCompress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Flush for FlushCompress

fn none() -> Self

fn sync() -> Self

fn finish() -> Self

impl PartialEq for FlushCompress

fn eq(&self, other: &FlushCompress) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FlushCompress

impl Eq for FlushCompress

impl StructuralPartialEq for FlushCompress