Enum CompressAlgorithm 

#[non_exhaustive]
pub enum CompressAlgorithm {
    Brotli(BrotliAlgorithm),
    Lz4,
    Snappy,
    Zstd(ZstdCompressionLevel),
    Unknown(u8),
}

Available on crate features zstd or lz4 or brotli or snappy only.

The compressioned algorithm used to compression the message.

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.

Brotli(BrotliAlgorithm)

Available on crate feature brotli only.

Brotli

Lz4

Available on crate feature lz4 only.

LZ4

Snappy

Available on crate feature snappy only.

Snappy

Zstd(ZstdCompressionLevel)

Available on crate feature zstd only.

Zstd

Unknown(u8)

Unknwon compressioned algorithm

Implementations

impl CompressAlgorithm

pub const fn is_brotli(&self) -> bool

Returns true if this value is of type Brotli. Returns false otherwise

pub const fn is_lz_4(&self) -> bool

Returns true if this value is of type Lz4. Returns false otherwise

pub const fn is_snappy(&self) -> bool

Returns true if this value is of type Snappy. Returns false otherwise

pub const fn is_zstd(&self) -> bool

Returns true if this value is of type Zstd. Returns false otherwise

pub const fn is_unknown(&self) -> bool

Returns true if this value is of type Unknown. Returns false otherwise

impl CompressAlgorithm

pub fn decompress_to( &self, src: &[u8], dst: &mut [u8], ) -> Result<usize, CompressionError>

Decompresses the given buffer.

pub fn max_compress_len( &self, input_size: usize, ) -> Result<usize, CompressionError>

Returns the maximum compressed length of the given buffer.

This is useful when you want to pre-allocate the buffer before compressing.

pub fn compress_to( &self, src: &[u8], dst: &mut [u8], ) -> Result<usize, CompressionError>

Compresses the given buffer.

The dst buffer should be pre-allocated with the max_compress_len method.

pub fn as_str(&self) -> Cow<'_, str>

Returns the string representation of the algorithm.

Trait Implementations

impl<'a> Arbitrary<'a> for CompressAlgorithm

Available on (crate features arbitrary) and (crate features zstd or snappy or lz4 or brotli) only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Arbitrary for CompressAlgorithm

Available on crate features quickcheck only.

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl Clone for CompressAlgorithm

fn clone(&self) -> CompressAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Data for CompressAlgorithm

const WIRE_TYPE: WireType = WireType::Varint

The wire type of the data.

type Ref<'a> = CompressAlgorithm

The reference type of the data.

fn from_ref(val: Self::Ref<'_>) -> Result<Self, DecodeError>

where Self: Sized,

Converts the reference type to the owned type.

fn encoded_len(&self) -> usize

Returns the encoded length of the data only considering the data itself, (e.g. no length prefix, no wire type).

fn encode(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message to a buffer.

fn encoded_len_with_length_delimited(&self) -> usize

Returns the encoded length of the data including the length delimited.

fn encode_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Available on crate features std or alloc only.

Encodes the message into a vec.

fn encode_to_bytes(&self) -> Result<Bytes, EncodeError>

Available on crate features std or alloc only.

Encodes the message into a Bytes.

fn encode_length_delimited(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Available on crate features std or alloc only.

Encodes the message with a length-delimiter into a vec.

fn encode_length_delimited_to_bytes(&self) -> Result<Bytes, EncodeError>

Available on crate features std or alloc only.

Encodes the message with a length-delimiter into a Bytes.

fn decode(src: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from the buffer.

impl<'a> DataRef<'a, CompressAlgorithm> for CompressAlgorithm

fn decode(buf: &'a [u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes the reference type from a buffer.

fn decode_length_delimited(src: &'a [u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited reference instance of the message from the buffer.

impl Debug for CompressAlgorithm

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

Formats the value using the given formatter.

impl Default for CompressAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompressAlgorithm

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CompressAlgorithm

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

Formats the value using the given formatter.

impl From<u16> for CompressAlgorithm

fn from(value: u16) -> Self

Converts to this type from the input type.

impl FromStr for CompressAlgorithm

type Err = ParseCompressAlgorithmError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CompressAlgorithm

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 CompressAlgorithm

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CompressAlgorithm

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CompressAlgorithm

impl Eq for CompressAlgorithm

impl StructuralPartialEq for CompressAlgorithm