Merge pull request #43 from Nemo157/version_bump

Version bump

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "roaring"
-version = "0.5.0"
+version = "0.5.1"
 authors = ["Wim Looman <[email protected]>"]
 description = "http://roaringbitmap.org : A better compressed bitset - pure Rust implementation "
 
@@ -9,8 +9,12 @@ repository = "https://github.com/Nemo157/roaring-rs"
 
 readme = "README.md"
 keywords = ["roaring", "data-structure", "bitmap"]
+categories = ["data-structures"]
 
 license = "MIT/Apache-2.0"
 
+[badges]
+travis-ci = { repository = "Nemo157/roaring-rs" }
+
 [dependencies]
 byteorder = "0.5.3"

src/bitmap/serialization.rs

@@ -13,6 +13,19 @@ const SERIAL_COOKIE: u16 = 12347;
 impl RoaringBitmap {
     /// Return the size in bytes of the serialized output.
     /// This is compatible with the official C/C++, Java and Go implementations.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// use roaring::RoaringBitmap;
+    ///
+    /// let rb1: RoaringBitmap = (1..4).collect();
+    /// let mut bytes = Vec::with_capacity(rb1.serialized_size());
+    /// rb1.serialize_into(&mut bytes).unwrap();
+    /// let rb2 = RoaringBitmap::deserialize_from(&mut &bytes[..]).unwrap();
+    ///
+    /// assert_eq!(rb1, rb2);
+    /// ```
     pub fn serialized_size(&self) -> usize {
         let container_sizes: usize = self.containers.iter().map(|container| {
             match container.store {

src/treemap/iter.rs

@@ -125,7 +125,7 @@ impl Iterator for IntoIter {
 }
 
 impl RoaringTreemap {
-    /// Iterator over each value stored in the RoaringBitmap, guarantees values are ordered by
+    /// Iterator over each value stored in the RoaringTreemap, guarantees values are ordered by
     /// value.
     ///
     /// # Examples