Struct flate2::Compression

pub struct Compression(/* private fields */);

When compressing data, the compression level can be specified by a value in this struct.

Implementations

impl Compression

pub const fn new(level: u32) -> Compression

Creates a new description of the compression level with an explicitly specified integer.

The integer here is typically on a scale of 0-9 where 0 means “no compression” and 9 means “take as long as you’d like”.

Backend differences

The miniz_oxide backend for flate2 does not support level 0 or Compression::none(). Instead it interprets them as the default compression level, which is quite slow. Compression::fast() should be used instead.

miniz_oxide also supports a non-compliant compression level 10. It is even slower and may result in higher compression, but only miniz_oxide will be able to read the data compressed with level 10. Do not use level 10 if you need other software to be able to read it!

pub const fn none() -> Compression

No compression is to be performed, this may actually inflate data slightly when encoding.

pub const fn fast() -> Compression

Optimize for the best speed of encoding.

pub const fn best() -> Compression

Optimize for the size of data being encoded.

pub fn level(&self) -> u32

Returns an integer representing the compression level, typically on a scale of 0-9. See new for details about compression levels.

Trait Implementations

impl Clone for Compression

fn clone(&self) -> Compression

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Compression

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

Formats the value using the given formatter.

impl Default for Compression

fn default() -> Compression

Returns the “default value” for a type.

impl PartialEq for Compression

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

impl Eq for Compression

impl StructuralPartialEq for Compression