Use bitflags module for bitflags (#184)

Author: kyeah

Cargo.toml

@@ -13,6 +13,7 @@ keywords = ["mongo", "mongodb", "database", "bson", "nosql"]
 license = "Apache-2.0"
 
 [dependencies]
+bitflags = "0.7.0"
 bson = "0.3.2"
 byteorder = "0.5.3"
 chrono = "0.2.25"

src/cursor.rs

@@ -30,7 +30,7 @@ use bson::{self, Bson};
 use common::{ReadMode, ReadPreference};
 use pool::PooledStream;
 use time;
-use wire_protocol::flags::OpQueryFlags;
+use wire_protocol::flags::{self, OpQueryFlags};
 use wire_protocol::operations::Message;
 
 use std::collections::vec_deque::VecDeque;
@@ -110,7 +110,7 @@ impl Cursor {
         Cursor::query(client.clone(),
                       format!("{}.$cmd", db),
                       1,
-                      OpQueryFlags::no_flags(),
+                      OpQueryFlags::empty(),
                       0,
                       0,
                       doc,
@@ -234,7 +234,7 @@ impl Cursor {
         let new_flags = if !slave_ok {
             flags
         } else {
-            OpQueryFlags { slave_ok: true, ..flags }
+            flags | flags::SLAVE_OK
         };
 
         // Send read_preference to the server based on the result from server selection.

src/lib.rs

@@ -88,6 +88,8 @@
 //! pool. By default, each pool has a maximum of 5 concurrent open connections.
 
 #[doc(html_root_url = "https://docs.rs/mongodb")]
+#[macro_use(bitflags)]
+extern crate bitflags;
 #[macro_use(bson, doc)]
 extern crate bson;
 extern crate byteorder;

src/wire_protocol/flags.rs

@@ -1,132 +1,44 @@
 //! Operation flags.
 use coll::options::{CursorType, FindOptions};
 
-/// Represents the bit vector of options for an OP_REPLY message.
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub struct OpReplyFlags {
-    pub cursor_not_found: bool, // Bit 0
-    pub query_failure: bool, // Bit 1
-    pub await_capable: bool, /* Bit 3
-                              *
-                              * All bits remaining must be 0 */
-}
-
-impl OpReplyFlags {
-    /// Constructs a new struct from a bit vector of options.
-    ///
-    /// # Return value
-    ///
-    /// Returns the newly-created struct.
-    pub fn from_i32(i: i32) -> OpReplyFlags {
-        let cursor_not_found = (i & 1) != 0;
-        let query_failure = (i & (1 << 1)) != 0;
-        let await_capable = (i & (1 << 3)) != 0;
-
-        OpReplyFlags {
-            cursor_not_found: cursor_not_found,
-            query_failure: query_failure,
-            await_capable: await_capable,
-        }
+bitflags! {
+    /// Represents the bit vector of options for an OP_REPLY message.
+    pub flags OpReplyFlags: i32 {
+        const CURSOR_NOT_FOUND  = 0b00000001,
+        const QUERY_FAILURE     = 0b00000010,
+        const AWAIT_CAPABLE     = 0b00001000,
     }
 }
 
-/// Represents the bit vector of options for an OP_UPDATE message.
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub struct OpUpdateFlags {
-    pub upsert: bool, // Bit 0
-    pub multi_update: bool, /* Bit 1
-                             *
-                             * All bits remaining must be 0 */
-}
-
-/// Represents the bit vector of flags for an OP_INSERT message.
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub struct OpInsertFlags {
-    pub continue_on_error: bool, /* Bit 0
-                                  *
-                                  * All bits remaining must be 0 */
-}
-
-/// Represents the bit vector of flags for an OP_QUERY message.
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub struct OpQueryFlags {
-    pub tailable_cursor: bool, // Bit 1
-    pub slave_ok: bool, // Bit 2
-    pub oplog_relay: bool, // Bit 3
-    pub no_cursor_timeout: bool, // Bit 4
-    pub await_data: bool, // Bit 5
-    pub exhaust: bool, // Bit 6
-    pub partial: bool, /* Bit 7
-                        * All bits remaining must be 0 */
-}
-
-impl OpUpdateFlags {
-    /// Constructs a new struct with all flags set to false.
-    ///
-    /// # Return value
-    ///
-    /// Returns the newly-created struct.
-    pub fn no_flags() -> OpUpdateFlags {
-        OpUpdateFlags {
-            upsert: false,
-            multi_update: false,
-        }
-    }
-
-    /// Gets the actual bit vector that the struct represents.
-    ///
-    /// # Return value
-    ///
-    /// Returns the bit vector as an i32.
-    pub fn to_i32(&self) -> i32 {
-        let mut i: i32 = if self.upsert { 1 } else { 0 };
-
-        if self.multi_update {
-            i |= 1 << 1;
-        }
-
-        i
+bitflags! {
+    /// Represents the bit vector of options for an OP_UPDATE message.
+    pub flags OpUpdateFlags: i32 {
+        const UPSERT       = 0b00000001,
+        const MULTI_UPDATE = 0b00000010,
     }
 }
 
-impl OpInsertFlags {
-    /// Constructs a new struct with all flags set to false.
-    ///
-    /// # Return value
-    ///
-    /// Returns the newly-created struct.
-    pub fn no_flags() -> OpInsertFlags {
-        OpInsertFlags { continue_on_error: false }
+bitflags! {
+    /// Represents the bit vector of flags for an OP_INSERT message.
+    pub flags OpInsertFlags: i32 {
+        const CONTINUE_ON_ERROR = 0b00000001,
     }
+}
 
-    /// Gets the actual bit vector that the struct represents.
-    ///
-    /// # Return value
-    ///
-    /// Returns the bit vector as an i32.
-    pub fn to_i32(&self) -> i32 {
-        if self.continue_on_error { 1 } else { 0 }
+bitflags! {
+    /// Represents the bit vector of flags for an OP_QUERY message.
+    pub flags OpQueryFlags: i32 {
+        const TAILABLE_CURSOR   = 0b00000010,
+        const SLAVE_OK          = 0b00000100,
+        const OPLOG_RELAY       = 0b00001000,
+        const NO_CURSOR_TIMEOUT = 0b00010000,
+        const AWAIT_DATA        = 0b00100000,
+        const EXHAUST           = 0b01000000,
+        const PARTIAL           = 0b10000000,
     }
 }
 
 impl OpQueryFlags {
-    /// Constructs a new struct with all flags set to false.
-    ///
-    /// # Return value
-    ///
-    /// Returns the newly-created struct.
-    pub fn no_flags() -> OpQueryFlags {
-        OpQueryFlags {
-            tailable_cursor: false,
-            slave_ok: false,
-            oplog_relay: false,
-            no_cursor_timeout: false,
-            await_data: false,
-            exhaust: false,
-            partial: false,
-        }
-    }
-
     /// Constructs a new struct with flags based on a FindOptions struct.
     ///
     /// # Arguments
@@ -138,53 +50,27 @@ impl OpQueryFlags {
     ///
     /// Returns the newly created OpQueryFlags struct.
     pub fn with_find_options(options: &FindOptions) -> OpQueryFlags {
-        OpQueryFlags {
-            tailable_cursor: options.cursor_type != CursorType::NonTailable,
-            slave_ok: false,
-            oplog_relay: options.op_log_replay,
-            no_cursor_timeout: options.no_cursor_timeout,
-            await_data: options.cursor_type == CursorType::TailableAwait,
-            exhaust: false,
-            partial: options.allow_partial_results,
-        }
-    }
-
-    /// Gets the actual bit vector that the struct represents.
-    ///
-    /// # Return value
-    ///
-    /// Returns the bit vector as an i32.
-    pub fn to_i32(&self) -> i32 {
-        let mut i = 0 as i32;
-
-        if self.tailable_cursor {
-            i |= 1 << 1;
-        }
-
-        if self.slave_ok {
-            i |= 1 << 2;
-        }
-
-        if self.oplog_relay {
-            i |= 1 << 3;
+        let mut flags = OpQueryFlags::empty();
+        if options.cursor_type != CursorType::NonTailable {
+            flags.insert(TAILABLE_CURSOR);
         }
 
-        if self.no_cursor_timeout {
-            i |= 1 << 4;
+        if options.op_log_replay {
+            flags.insert(OPLOG_RELAY);
         }
 
-        if self.await_data {
-            i |= 1 << 5;
+        if options.no_cursor_timeout {
+            flags.insert(NO_CURSOR_TIMEOUT);
         }
 
-        if self.exhaust {
-            i |= 1 << 6;
+        if options.cursor_type == CursorType::TailableAwait {
+            flags.insert(AWAIT_DATA);
         }
 
-        if self.partial {
-            i |= 1 << 7;
+        if options.allow_partial_results {
+            flags.insert(PARTIAL);
         }
 
-        i
+        flags
     }
 }

src/wire_protocol/operations.rs

@@ -114,7 +114,7 @@ impl Message {
                  -> Message {
         Message::OpReply {
             header: header,
-            flags: OpReplyFlags::from_i32(flags),
+            flags: OpReplyFlags::from_bits_truncate(flags),
             cursor_id: cursor_id,
             starting_from: starting_from,
             number_returned: number_returned,
@@ -305,7 +305,7 @@ impl Message {
         // Writes the null terminator for the collection name string.
         try!(buffer.write_u8(0));
 
-        try!(buffer.write_i32::<LittleEndian>(flags.to_i32()));
+        try!(buffer.write_i32::<LittleEndian>(flags.bits()));
 
         try!(Message::write_bson_document(buffer, selector));
         try!(Message::write_bson_document(buffer, update));
@@ -336,7 +336,7 @@ impl Message {
                               -> Result<()> {
 
         try!(header.write(buffer));
-        try!(buffer.write_i32::<LittleEndian>(flags.to_i32()));
+        try!(buffer.write_i32::<LittleEndian>(flags.bits()));
 
         for byte in namespace.bytes() {
             try!(buffer.write_u8(byte));
@@ -385,7 +385,7 @@ impl Message {
                              -> Result<()> {
 
         try!(header.write(buffer));
-        try!(buffer.write_i32::<LittleEndian>(flags.to_i32()));
+        try!(buffer.write_i32::<LittleEndian>(flags.bits()));
 
         for byte in namespace.bytes() {
             try!(buffer.write_u8(byte));

tests/client/cursor.rs

@@ -23,7 +23,7 @@ fn cursor_features() {
     assert!(coll.insert_many(docs, None).is_ok());
 
     let doc = Document::new();
-    let flags = OpQueryFlags::no_flags();
+    let flags = OpQueryFlags::empty();
 
     let result = Cursor::query(client.clone(),
                                "test-client-cursor.cursor_test".to_owned(),

tests/client/wire_protocol.rs

@@ -16,7 +16,7 @@ fn insert_single_key_doc() {
             let doc = doc! { "foo" => 42.0 };
 
             let docs = vec![doc];
-            let flags = OpInsertFlags::no_flags();
+            let flags = OpInsertFlags::empty();
             let name = "test-client-wire_protocol-insert_single_key_doc.single_key".to_owned();
             let res = Message::new_insert(1, flags, name, docs);
 
@@ -31,7 +31,7 @@ fn insert_single_key_doc() {
             };
 
             let doc = Document::new();
-            let flags = OpQueryFlags::no_flags();
+            let flags = OpQueryFlags::empty();
             let name = "test-client-wire_protocol-insert_single_key_doc.single_key".to_owned();
             let res = Message::new_query(1, flags, name, 0, 0, doc, None);
 
@@ -80,7 +80,7 @@ fn insert_multi_key_doc() {
             };
 
             let docs = vec![doc];
-            let flags = OpInsertFlags::no_flags();
+            let flags = OpInsertFlags::empty();
             let name = "test-client-wire_protocol-insert_multi_key_doc.multi_key".to_owned();
             let res = Message::new_insert(1, flags, name, docs);
 
@@ -95,7 +95,7 @@ fn insert_multi_key_doc() {
             };
 
             let doc = Document::new();
-            let flags = OpQueryFlags::no_flags();
+            let flags = OpQueryFlags::empty();
             let name = "test-client-wire_protocol-insert_multi_key_doc.multi_key".to_owned();
             let res = Message::new_query(1, flags, name, 0, 0, doc, None);
 
@@ -153,7 +153,7 @@ fn insert_docs() {
             };
 
             let docs = vec![doc1, doc2];
-            let flags = OpInsertFlags::no_flags();
+            let flags = OpInsertFlags::empty();
             let name = "test-client-wire_protocol-insert_docs.multi_doc".to_owned();
             let res = Message::new_insert(1, flags, name, docs);
 
@@ -168,7 +168,7 @@ fn insert_docs() {
             };
 
             let doc = Document::new();
-            let flags = OpQueryFlags::no_flags();
+            let flags = OpQueryFlags::empty();
             let name = "test-client-wire_protocol-insert_docs.multi_doc".to_owned();
             let res = Message::new_query(1, flags, name, 0, 0, doc, None);
 
@@ -226,7 +226,7 @@ fn insert_update_then_query() {
             let doc = doc! { "foo" => 42.0 };
 
             let docs = vec![doc];
-            let flags = OpInsertFlags::no_flags();
+            let flags = OpInsertFlags::empty();
             let name = "test-client-wire_protocol-insert_update_then_query.update".to_owned();
             let res = Message::new_insert(1, flags, name, docs);
 
@@ -244,7 +244,7 @@ fn insert_update_then_query() {
 
             let update = doc! { "foo" => "bar" };
 
-            let flags = OpUpdateFlags::no_flags();
+            let flags = OpUpdateFlags::empty();
             let name = "test-client-wire_protocol-insert_update_then_query.update".to_owned();
             let res = Message::new_update(2, name, flags, selector, update);
 
@@ -259,7 +259,7 @@ fn insert_update_then_query() {
             };
 
             let doc = Document::new();
-            let flags = OpQueryFlags::no_flags();
+            let flags = OpQueryFlags::empty();
             let name = "test-client-wire_protocol-insert_update_then_query.update".to_owned();
             let res = Message::new_query(3, flags, name, 0, 0, doc, None);