Enum Compression

pub enum Compression {
    Lz4,
    Snappy,
    None,
}

Enum which represents a type of compression. Only non-startup frame’s body can be compressen.

Variants

Lz4

lz4 compression

Snappy

snappy compression

None

Non compression

Implementations

impl Compression

pub fn encode(&self, bytes: Vec<u8>) -> Result<Vec<u8>, CompressionError>

It encodes bytes basing on type of Compression..

Examples

   use cdrs::compression::Compression;

  let snappy_compression = Compression::Snappy;
  let bytes = String::from("Hello World").into_bytes().to_vec();
  let encoded = snappy_compression.encode(bytes.clone()).unwrap();
  assert_eq!(snappy_compression.decode(encoded).unwrap(), bytes);

pub fn decode(&self, bytes: Vec<u8>) -> Result<Vec<u8>, CompressionError>

It decodes bytes basing on type of compression.

Examples

   use cdrs::compression::Compression;
    let lz4_compression = Compression::Lz4;
    let bytes = String::from("Hello World").into_bytes().to_vec();
    let encoded = lz4_compression.encode(bytes.clone()).unwrap();
    let len = encoded.len() as u8;
    let mut input = vec![0, 0, 0, len];
    input.extend_from_slice(encoded.as_slice());
    assert_eq!(lz4_compression.decode(input).unwrap(), bytes);

pub fn as_str(&self) -> Option<&'static str>

It transforms compression method into a &str.

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<'a> From<&'a str> for Compression

fn from(compression_str: &'a str) -> Compression

It converts str into Compression. If string is neither lz4 nor snappy then Compression::None will be returned

impl From<String> for Compression

fn from(compression_string: String) -> Compression

It converts String into Compression. If string is neither lz4 nor snappy then Compression::None will be returned

impl Ord for Compression

fn cmp(&self, other: &Compression) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Compression

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

fn partial_cmp(&self, other: &Compression) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Compression

impl Eq for Compression

impl StructuralPartialEq for Compression