Enum Format 

#[non_exhaustive]
pub enum Format {
    Raw,
    Zlib,
    Gzip,
}

A compressed format.

Examples

use compress_lib::{Format, gzip, zlib};

assert_eq!(Format::detect(&gzip::compress(b"x")), Some(Format::Gzip));
assert_eq!(Format::detect(&zlib::compress(b"x")), Some(Format::Zlib));
assert_eq!(Format::detect(b"plain text"), None);

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.

Raw

Raw DEFLATE (RFC 1951): no header, no checksum.

Zlib

zlib (RFC 1950); also HTTP’s deflate content coding.

Gzip

gzip (RFC 1952); HTTP’s gzip content coding.

Implementations

impl Format

pub fn detect(data: &[u8]) -> Option<Format>

Recognises gzip by its magic number and zlib by its header check. Raw DEFLATE has no header and is never guessed. Needs at least two bytes.

Examples

use compress_lib::Format;

assert_eq!(Format::detect(&[0x1F, 0x8B]), Some(Format::Gzip));
assert_eq!(Format::detect(&[0x78, 0x9C]), Some(Format::Zlib));
assert_eq!(Format::detect(&[0x78]), None);

Trait Implementations

impl Clone for Format

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl Hash for Format

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Format