Enum Compress

Source

pub enum Compress {
    Gzip,
    Deflate,
    Br,
    Unknown,
}

Variants§

§

Unknown

Implementations§

Source §

impl Compress

Source

pub fn is_unknown(&self) -> bool

Checks if the current instance is of the Unknown type.

This method compares the current instance with the Unknown variant of the enum. It returns true if the instance is of type Unknown, otherwise false.

§Returns

true if the instance is of type Unknown.
false otherwise.

Source

pub fn from( header: &HashMap<String, String, BuildHasherDefault<Hasher>>, ) -> Compress

Extracts the compression type from an HTTP header.

This function looks for the Content-Encoding header in the provided Header and attempts to parse it into a Compress enum value.

§Arguments

header - The HTTP header from which the compression type is to be extracted.

§Returns

The Compress value corresponding to the Content-Encoding header, or Compress::Unknown if the header does not match any known compression types.

Source

pub fn decode<'a>(&self, data: &'a [u8], buffer_size: usize) -> Cow<'a, Vec<u8>>

Decompresses the given data based on the selected compression algorithm.

This method takes a byte slice of compressed data and decompresses it using one of the following compression algorithms, depending on the variant of the enum it is called on:

Gzip - Decompresses using Gzip compression.
Deflate - Decompresses using Deflate compression.
Br - Decompresses using Brotli compression.
Unknown - Returns the input data as-is (no decompression performed).

§Parameters

data - A reference to a byte slice (&[u8]) containing the compressed data to be decoded.
buffer_size - The buffer size to use for the decompression process. A larger buffer size can improve performance for larger datasets.

§Returns

Cow<Vec<u8>> - The decompressed data as a Cow<Vec<u8>>. If the compression algorithm is Unknown, the original data is returned unchanged, as a borrowed reference. Otherwise, the decompressed data is returned as an owned Vec<u8>.

Source

pub fn encode<'a>(&self, data: &'a [u8], buffer_size: usize) -> Cow<'a, Vec<u8>>

Compresses the given data based on the selected compression algorithm.

This method takes a byte slice of data and compresses it using one of the following compression algorithms, depending on the variant of the enum it is called on:

Gzip - Compresses using Gzip compression.
Deflate - Compresses using Deflate compression.
Br - Compresses using Brotli compression.
Unknown - Returns the input data as-is (no compression performed).

§Parameters

data - A reference to a byte slice (&[u8]) containing the data to be compressed.
buffer_size - The buffer size to use for the compression process. A larger buffer size can improve performance for larger datasets.

§Returns

Cow<Vec<u8>> - The compressed data as a Cow<Vec<u8>>. If the compression algorithm is Unknown, the original data is returned unchanged, as a borrowed reference. Otherwise, the compressed data is returned as an owned Vec<u8>.