pub struct HuffmanData {
    pub encoded_data: Vec<u8>,
    pub encoding_map: HashMap<u8, String>,
    pub stats: EncodingStats,
}
Expand description

Huffman encoded data

Fields§

§encoded_data: Vec<u8>

The encoded data as a Vec<u8>

§encoding_map: HashMap<u8, String>

Encoding map stored as a HashMap<u8,String> required for decoding the data

§stats: EncodingStats

Implementations§

source§

impl HuffmanData

source

pub fn new(data: &Vec<u8>) -> Result<HuffmanData, &'static str>

Huffman encodes a Vec<u8> returning a HuffmanData struct

Arguments
  • data - A reference to Vec<u8> containing the data you want to encode
Examples
extern crate huff_tree_tap;
use  huff_tree_tap::*;
use std::collections::HashMap;

let data: Vec<u8> = "this is a test string!".to_string().into_bytes();
let huffman_data: HuffmanData = HuffmanData::new(&data).unwrap();
let decoded_data: Vec<u8> = huffman_data.decode().unwrap();
assert_eq!(decoded_data,data);
source

pub fn decode(self) -> Result<Vec<u8>, &'static str>

Huffman decodes a HuffmanData struct and returns a decoded Vec<u8>

Arguments
  • huffman_encoded_data - A reference to HuffmanData containing the encoded data and encoding map
Examples
extern crate huff_tree_tap;
use  huff_tree_tap::*;
use std::collections::HashMap;

let data: Vec<u8> = "this is a test string!".to_string().into_bytes();
let huffman_data: HuffmanData = HuffmanData::new(&data).unwrap();
let decoded_data: Vec<u8> = huffman_data.decode().unwrap();
assert_eq!(decoded_data,data);

Trait Implementations§

source§

impl Debug for HuffmanData

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for HuffmanData

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for HuffmanData

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,