Struct rscache::util::Huffman

pub struct Huffman { /* private fields */ }

Decompresses chat messages.

Examples

use rscache::util::Huffman;

let huffman_tbl = cache.huffman_table()?;
let huffman = Huffman::new(&huffman_tbl);

let compressed_msg = &[174, 128, 35, 32, 208, 96];
let decompressed_len = 8; // client will include this in the chat packet.

let decompressed_msg = huffman.decompress(compressed_msg, decompressed_len);

if let Ok(msg) = String::from_utf8(decompressed_msg) {
    assert_eq!(msg, "rs-cache");
}

Implementations

impl Huffman

pub fn new(sizes: &[u8]) -> Self

Initializes the Huffman struct with the given sizes.

The sizes can be found in the cache. Call the huffman_table() function to get the huffman table which contains the sizes needed to initialize this struct.

pub fn decompress(&self, compressed: &[u8], decompressed_len: usize) -> Vec<u8>

Decompresses the given buffer.

The buffer is normally an encoded chat message which will be decoded into the original message. This helps limit chat packet sizes.

Panics

Panics if the decompressed length == 0

Trait Implementations

impl Clone for Huffman

fn clone(&self) -> Huffman

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Huffman

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

Formats the value using the given formatter.

impl Default for Huffman

fn default() -> Huffman

Returns the “default value” for a type.

impl Hash for Huffman

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Huffman

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Huffman> for Huffman

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Huffman> for Huffman

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Huffman

impl StructuralEq for Huffman

impl StructuralPartialEq for Huffman