fixed tests, add doc

Author: zonyitoo

src/bson.rs

@@ -19,6 +19,8 @@
 // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+//! BSON definition
+
 use std::collections::BTreeMap;
 use std::string;
 

src/decoder.rs

@@ -19,6 +19,8 @@
 // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+//! Decoder
+
 use std::io::{self, Read};
 use std::str;
 use std::convert::From;

src/encoder.rs

@@ -19,6 +19,8 @@
 // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+//! Encoder
+
 use std::io::{self, Write};
 use std::convert::From;
 use std::mem;
@@ -325,7 +327,7 @@ mod test {
             enc.encode_document(&doc).unwrap();
         }
 
-        assert_eq!(&buf[..], dst);
+        assert_eq!(&buf[..], &dst[..]);
     }
 
     #[test]
@@ -342,6 +344,6 @@ mod test {
             enc.encode_document(&doc).unwrap();
         }
 
-        panic!("{:?}", buf);
+        assert_eq!(&buf[..], &dst[..]);
     }
 }

src/lib.rs

@@ -21,6 +21,36 @@
 
 #![feature(core)]
 
+//! BSON is a binary format in which zero or more key/value pairs are stored as a single entity.
+//! We call this entity a document.
+//!
+//! This library supports Version 1.0 of BSON standard.
+//!
+//! ## Basic usage
+//!
+//! ```rust
+//! extern crate bson;
+//! use std::io::Cursor;
+//! use bson::{Bson, Document, Encoder, Decoder};
+//!
+//! fn main() {
+//!     let mut doc = Document::new();
+//!     doc.insert("foo".to_string(), Bson::String("bar".to_string()));
+//!
+//!     let mut buf = Vec::new();
+//!     {
+//!         let mut enc = Encoder::new(&mut buf);
+//!         enc.encode_document(&doc).unwrap();
+//!     }
+//!
+//!     let mut r = Cursor::new(&buf[..]);
+//!     {
+//!         let mut dec = Decoder::new(&mut r);
+//!         let doc = dec.decode_document().unwrap();
+//!     }
+//! }
+//! ```
+
 extern crate rustc_serialize;
 extern crate chrono;
 extern crate byteorder;

src/spec.rs

@@ -19,7 +19,7 @@
 // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-/// BSON Specification Version 1.0
+//! BSON Specification Version 1.0
 /// http://bsonspec.org/spec.html
 
 use std::convert::From;