Features serde

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "huffman-compress"
-version = "0.6.1" # remember to update html_root_url and changelog
+version = "0.6.1"                                                                           # remember to update html_root_url and changelog
 authors = ["Niklas Fiekas <[email protected]>"]
 license = "MIT OR Apache-2.0"
 keywords = ["huffman", "compression", "decompression"]
@@ -16,10 +16,17 @@ harness = false
 [dependencies]
 bit-vec = "0.6"
 num-traits = "0.2"
+serde = { version = "1.0.164", default-features = false, optional = true, features = [
+    "derive",
+] }
 
 [dev-dependencies]
 bencher = "0.1"
 quickcheck = "1"
 
 [badges]
 travis-ci = { repository = "niklasf/rust-huffman-compress", branch = "master" }
+
+[features]
+default = []
+serde = ["serde/std"]

README.md

@@ -9,6 +9,16 @@ given a probability distribution over arbitrary symbols.
 [![docs.rs](https://docs.rs/huffman-compress/badge.svg)](https://docs.rs/huffman-compress)
 [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
 
+Feature
+-------
+
+If you want serde support, include the feature like this:
+
+```
+[dependencies]
+bit-vec = { version = "0.6", features = ["serde"] }
+```
+
 Examples
 --------
 

src/lib.rs

@@ -80,19 +80,27 @@ use bit_vec::BitVec;
 
 use num_traits::ops::saturating::Saturating;
 
+#[cfg(feature = "serde")]
+extern crate serde;
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
 /// A trie used for decoding.
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, Clone)]
 pub struct Tree<K> {
     root: usize,
     arena: Vec<Node<K>>,
 }
 
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, Clone)]
 struct Node<K> {
     parent: Option<usize>,
     data: NodeData<K>,
 }
 
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, Clone)]
 enum NodeData<K> {
     Leaf { symbol: K },