Merge pull request #115 from kyeah/documentation

Organized documentation and added module-level documentation

Author: vkarpov15

Cargo.toml

@@ -4,8 +4,10 @@ version = "0.1.0"
 authors = ["Valeri Karpov <[email protected]>",
            "Saghm Rossi <[email protected]>",
            "Kevin Yeh <[email protected]>"]
+
 description = "An experimental MongoDB driver written by MongoDB interns."
 repository = "https://github.com/mongodbinc-interns/mongo-rust-driver-prototype"
+documentation = "https://mongodbinc-interns.github.io/mongo-rust-driver-prototype/mongodb"
 readme = "README.md"
 keywords = ["mongo", "mongodb", "database", "bson", "nosql"]
 license = "apache"

src/apm/mod.rs

@@ -1,3 +1,9 @@
+//! Command Monitoring
+//!
+//! The APM module provides an intuitive interface for monitoring and responding to runtime information
+//! about commands being executed on the server. All non-suppressed commands trigger start and completion
+//! hooks defined on the client. Each non-suppressed command is also logged, if a log file was specified
+//! during instantiation of the client.
 pub mod client;
 mod event;
 mod listener;

src/auth.rs

@@ -1,3 +1,4 @@
+//! Authentication schemes.
 use bson::Bson::{self, Binary};
 use bson::Document;
 use bson::spec::BinarySubtype::Generic;
@@ -19,6 +20,7 @@ const B64_CONFIG : base64::Config = base64::Config { char_set: base64::Character
                                                      newline: base64::Newline::LF,
                                                      pad: true, line_length: None };
 
+/// Handles SCRAM-SHA-1 authentication logic.
 pub struct Authenticator {
     db: Database,
 }
@@ -37,10 +39,12 @@ struct AuthData {
 }
 
 impl Authenticator {
+    /// Creates a new authenticator.
     pub fn new(db: Database) -> Authenticator {
         Authenticator { db: db }
     }
 
+    /// Authenticates a user-password pair against a database.
     pub fn auth(self, user: &str, password: &str) -> Result<()> {
         let initial_data = try!(self.start(user));
         let conversation_id = initial_data.conversation_id.clone();

src/coll/batch.rs

@@ -1,3 +1,4 @@
+//! Models for collection-level batch operations.
 use super::options::WriteModel;
 
 use bson::Document;

src/coll/error.rs

@@ -1,3 +1,4 @@
+//! Write errors for collection-level operations.
 use bson::{self, Bson};
 use super::options::WriteModel;
 use common::WriteConcern;

src/coll/mod.rs

@@ -1,3 +1,4 @@
+//! Interface for collection-level operations.
 mod batch;
 pub mod error;
 pub mod options;
@@ -25,7 +26,9 @@ use std::iter::FromIterator;
 
 /// Interfaces with a MongoDB collection.
 pub struct Collection {
+    /// A reference to the database that spawned this collection.
     pub db: Database,
+    /// The namespace of this collection, formatted as db_name.coll_name.
     pub namespace: String,
     read_preference: ReadPreference,
     write_concern: WriteConcern,

src/coll/options.rs

@@ -1,3 +1,4 @@
+//! Options for collection-level operations.
 use bson::{self, Bson};
 use cursor;
 use common::{ReadPreference, WriteConcern};
@@ -115,6 +116,7 @@ pub struct FindOneAndUpdateOptions {
 }
 
 /// Options for index operations.
+#[derive(Clone)]
 pub struct IndexOptions {
     pub background: Option<bool>,
     pub expire_after_seconds: Option<i32>,
@@ -139,17 +141,20 @@ pub struct IndexOptions {
 }
 
 /// A single index model.
+#[derive(Clone)]
 pub struct IndexModel {
     pub keys: bson::Document,
     pub options: IndexOptions,
 }
 
+/// Options for insertMany operations.
 #[derive(Clone)]
 pub struct InsertManyOptions {
     pub ordered: bool,
     pub write_concern: Option<WriteConcern>,
 }
 
+/// Options for update operations.
 #[derive(Clone)]
 pub struct UpdateOptions {
     pub upsert: bool,

src/coll/results.rs

@@ -1,3 +1,4 @@
+//! Results for collection-level operations.
 use bson;
 use bson::Bson;
 use std::collections::BTreeMap;

src/command_type.rs

@@ -1,3 +1,6 @@
+//! Monitorable command types.
+
+/// Executable command types that can be monitored by the driver.
 #[derive(PartialEq, Eq, Clone)]
 pub enum CommandType {
     Aggregate,

src/common.rs

@@ -1,3 +1,4 @@
+//! Library-wide utilities.
 use Error::{self, ArgumentError};
 use Result;
 
@@ -16,7 +17,7 @@ pub enum ReadMode {
     Nearest,
 }
 
-impl FromStr for ReadMode {   
+impl FromStr for ReadMode {
     type Err = Error;
     fn from_str(s: &str) -> Result<Self> {
         Ok(match s {
@@ -63,10 +64,14 @@ impl ReadPreference {
 
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct WriteConcern {
-    pub w: i32,          // Write replication
-    pub w_timeout: i32,  // Used in conjunction with 'w'. Propagation timeout in ms.
-    pub j: bool,         // If true, will block until write operations have been committed to journal.
-    pub fsync: bool,     // If true and server is not journaling, blocks until server has synced all data files to disk.
+    /// Write replication
+    pub w: i32,
+    /// Used in conjunction with 'w'. Propagation timeout in ms.
+    pub w_timeout: i32,
+    /// If true, will block until write operations have been committed to journal.
+    pub j: bool,
+    /// If true and server is not journaling, blocks until server has synced all data files to disk.
+    pub fsync: bool,
 }
 
 impl WriteConcern {