Enum flate2::FlushDecompress

#[non_exhaustive]
pub enum FlushDecompress {
    None = 0,
    Sync = 2,
    Finish = 4,
}

Values which indicate the form of flushing to be used when decompressing 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.

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 FlushDecompress

fn clone(&self) -> FlushDecompress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlushDecompress

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

Formats the value using the given formatter.

impl Flush for FlushDecompress

fn none() -> Self

fn sync() -> Self

fn finish() -> Self

impl PartialEq for FlushDecompress

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for FlushDecompress

impl Eq for FlushDecompress

impl StructuralPartialEq for FlushDecompress