Enum flate2::Flush

pub enum Flush {
    None,
    Sync,
    Partial,
    Block,
    Full,
    Finish,
}

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

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.

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.

Partial

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 decompessor to finish the block before the empty fixed code block.

Block

A deflate block is completed and emitted, as for Flush::Sync, but the output is not aligned on a byte boundary and up to seven vits of the current block are held to be written as the next byte after the next deflate block is completed.

In this case the decompressor may not be provided enough bits at this point in order to complete decompression of the data provided so far to the compressor, it may need to wait for the next block to be emitted. This is for advanced applications that need to control the emission of deflate blocks.

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.

Trait Implementations

impl Clone for Flush

fn clone(&self) -> Flush

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flush

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

Formats the value using the given formatter.

impl PartialEq<Flush> for Flush

fn eq(&self, other: &Flush) -> 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 Flush

impl Eq for Flush

impl StructuralEq for Flush

impl StructuralPartialEq for Flush