RUST-261 Mark enums and options structs as non-exhaustible (#178)

Author: saghm

src/client/options/mod.rs

@@ -193,6 +193,7 @@ impl fmt::Display for StreamAddress {
 /// Contains the options that can be used to create a new [`Client`](../struct.Client.html).
 #[derive(Clone, Derivative, TypedBuilder)]
 #[derivative(Debug, PartialEq)]
+#[non_exhaustive]
 pub struct ClientOptions {
     /// The initial list of seeds that the Client should connect to.
     ///
@@ -416,6 +417,7 @@ impl From<TlsOptions> for Option<Tls> {
 
 /// Specifies the TLS configuration that the [`Client`](../struct.Client.html) should use.
 #[derive(Clone, Debug, Default, PartialEq, TypedBuilder)]
+#[non_exhaustive]
 pub struct TlsOptions {
     /// Whether or not the [`Client`](../struct.Client.html) should return an error if the server
     /// presents an invalid certificate. This setting should _not_ be set to `true` in
@@ -513,6 +515,7 @@ impl TlsOptions {
 /// Extra information to append to the driver version in the metadata of the handshake with the
 /// server. This should be used by libraries wrapping the driver, e.g. ODMs.
 #[derive(Clone, Debug, TypedBuilder, PartialEq)]
+#[non_exhaustive]
 pub struct DriverInfo {
     /// The name of the library wrapping the driver.
     pub name: String,
@@ -1238,20 +1241,16 @@ impl ClientOptionsParser {
                 self.read_preference = Some(match &value.to_lowercase()[..] {
                     "primary" => ReadPreference::Primary,
                     "secondary" => ReadPreference::Secondary {
-                        tag_sets: None,
-                        max_staleness: None,
+                        options: Default::default(),
                     },
                     "primarypreferred" => ReadPreference::PrimaryPreferred {
-                        tag_sets: None,
-                        max_staleness: None,
+                        options: Default::default(),
                     },
                     "secondarypreferred" => ReadPreference::SecondaryPreferred {
-                        tag_sets: None,
-                        max_staleness: None,
+                        options: Default::default(),
                     },
                     "nearest" => ReadPreference::Nearest {
-                        tag_sets: None,
-                        max_staleness: None,
+                        options: Default::default(),
                     },
                     other => {
                         return Err(ErrorKind::ArgumentError {
@@ -1484,7 +1483,7 @@ mod tests {
     use super::{ClientOptions, StreamAddress};
     use crate::{
         concern::{Acknowledgment, ReadConcernLevel, WriteConcern},
-        selection_criteria::ReadPreference,
+        selection_criteria::{ReadPreference, ReadPreferenceOptions},
     };
 
     macro_rules! tag_set {
@@ -1807,17 +1806,18 @@ mod tests {
                 ],
                 selection_criteria: Some(
                     ReadPreference::SecondaryPreferred {
-                        tag_sets: Some(vec![
-                            tag_set! {
-                                "dc" => "ny",
-                                "rack" => "1"
-                            },
-                            tag_set! {
-                                "dc" => "ny"
-                            },
-                            tag_set! {},
-                        ]),
-                        max_staleness: None,
+                        options: ReadPreferenceOptions::builder()
+                            .tag_sets(vec![
+                                tag_set! {
+                                    "dc" => "ny",
+                                    "rack" => "1"
+                                },
+                                tag_set! {
+                                    "dc" => "ny"
+                                },
+                                tag_set! {},
+                            ])
+                            .build()
                     }
                     .into()
                 ),

src/client/options/test.rs

@@ -86,22 +86,20 @@ fn document_from_client_options(mut options: ClientOptions) -> Document {
     if let Some(SelectionCriteria::ReadPreference(read_pref)) = options.selection_criteria.take() {
         let (level, tag_sets, max_staleness) = match read_pref {
             ReadPreference::Primary => ("primary", None, None),
-            ReadPreference::PrimaryPreferred {
-                tag_sets,
-                max_staleness,
-            } => ("primaryPreferred", tag_sets, max_staleness),
-            ReadPreference::Secondary {
-                tag_sets,
-                max_staleness,
-            } => ("secondary", tag_sets, max_staleness),
-            ReadPreference::SecondaryPreferred {
-                tag_sets,
-                max_staleness,
-            } => ("secondaryPreferred", tag_sets, max_staleness),
-            ReadPreference::Nearest {
-                tag_sets,
-                max_staleness,
-            } => ("nearest", tag_sets, max_staleness),
+            ReadPreference::PrimaryPreferred { options } => {
+                ("primaryPreferred", options.tag_sets, options.max_staleness)
+            }
+            ReadPreference::Secondary { options } => {
+                ("secondary", options.tag_sets, options.max_staleness)
+            }
+            ReadPreference::SecondaryPreferred { options } => (
+                "secondaryPreferred",
+                options.tag_sets,
+                options.max_staleness,
+            ),
+            ReadPreference::Nearest { options } => {
+                ("nearest", options.tag_sets, options.max_staleness)
+            }
         };
 
         doc.insert("readpreference", level);

src/client/session/test.rs

@@ -465,20 +465,16 @@ async fn find_and_getmore_share_session() {
     let read_preferences: Vec<ReadPreference> = vec![
         ReadPreference::Primary,
         ReadPreference::PrimaryPreferred {
-            tag_sets: None,
-            max_staleness: None,
+            options: Default::default(),
         },
         ReadPreference::Secondary {
-            tag_sets: None,
-            max_staleness: None,
+            options: Default::default(),
         },
         ReadPreference::SecondaryPreferred {
-            tag_sets: None,
-            max_staleness: None,
+            options: Default::default(),
         },
         ReadPreference::Nearest {
-            tag_sets: None,
-            max_staleness: None,
+            options: Default::default(),
         },
     ];
 

src/cmap/test/integration.rs

@@ -30,8 +30,7 @@ async fn acquire_connection_and_send_command() {
 
     let body = doc! { "listDatabases": 1 };
     let read_pref = ReadPreference::PrimaryPreferred {
-        tag_sets: None,
-        max_staleness: None,
+        options: Default::default(),
     };
     let cmd = Command::new_read(
         "listDatabases".to_string(),

src/coll/options.rs

@@ -15,6 +15,7 @@ use crate::{
 /// These are the valid options for creating a [`Collection`](../struct.Collection.html) with
 /// [`Database::collection_with_options`](../struct.Database.html#method.collection_with_options).
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct CollectionOptions {
     /// The default read preference for operations.
     #[builder(default)]
@@ -34,6 +35,7 @@ pub struct CollectionOptions {
 /// [`Collection::find_one_and_update`](../struct.Collection.html#method.find_one_and_update)
 /// operation should return the document before or after modification.
 #[derive(Debug)]
+#[non_exhaustive]
 pub enum ReturnDocument {
     /// Return the document after modification.
     After,
@@ -44,6 +46,7 @@ pub enum ReturnDocument {
 /// Specifies the index to use for an operation.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 #[serde(untagged)]
+#[non_exhaustive]
 pub enum Hint {
     /// Specifies the keys of the index to use.
     Keys(Document),
@@ -62,6 +65,7 @@ impl Hint {
 
 /// Specifies the type of cursor to return from a find operation.
 #[derive(Debug, Clone, Copy)]
+#[non_exhaustive]
 pub enum CursorType {
     /// Default; close the cursor after the last document is received from the server.
     NonTailable,
@@ -78,6 +82,7 @@ pub enum CursorType {
 /// Specifies the options to a
 /// [`Collection::insert_one`](../struct.Collection.html#method.insert_one) operation.
 #[derive(Clone, Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct InsertOneOptions {
     /// Opt out of document-level validation.
     #[builder(default)]
@@ -93,6 +98,7 @@ pub struct InsertOneOptions {
 #[skip_serializing_none]
 #[derive(Clone, Debug, Default, TypedBuilder, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct InsertManyOptions {
     /// Opt out of document-level validation.
     #[builder(default)]
@@ -126,6 +132,7 @@ impl InsertManyOptions {
 /// [documentation](https://docs.mongodb.com/manual/reference/command/update/#update-command-behaviors)
 #[derive(Clone, Debug, Serialize)]
 #[serde(untagged)]
+#[non_exhaustive]
 pub enum UpdateModifications {
     /// A document that contains only update operator expressions.
     Document(Document),
@@ -162,6 +169,7 @@ impl From<Vec<Document>> for UpdateModifications {
 /// [`Collection::update_one`](../struct.Collection.html#method.update_one) or
 /// [`Collection::update_many`](../struct.Collection.html#method.update_many) operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct UpdateOptions {
     /// A set of filters specifying to which array elements an update should apply.
     ///
@@ -213,6 +221,7 @@ impl UpdateOptions {
 /// Specifies the options to a
 /// [`Collection::replace_one`](../struct.Collection.html#method.replace_one) operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct ReplaceOptions {
     /// Opt out of document-level validation.
     #[builder(default)]
@@ -247,6 +256,7 @@ pub struct ReplaceOptions {
 #[serde_with::skip_serializing_none]
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct DeleteOptions {
     /// The collation to use for the operation.
     ///
@@ -264,6 +274,7 @@ pub struct DeleteOptions {
 /// [`Collection::find_one_and_delete`](../struct.Collection.html#method.find_one_and_delete)
 /// operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct FindOneAndDeleteOptions {
     /// The maximum amount of time to allow the query to run.
     ///
@@ -296,6 +307,7 @@ pub struct FindOneAndDeleteOptions {
 /// [`Collection::find_one_and_replace`](../struct.Collection.html#method.find_one_and_replace)
 /// operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct FindOneAndReplaceOptions {
     /// Opt out of document-level validation.
     #[builder(default)]
@@ -340,6 +352,7 @@ pub struct FindOneAndReplaceOptions {
 /// [`Collection::find_one_and_update`](../struct.Collection.html#method.find_one_and_update)
 /// operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct FindOneAndUpdateOptions {
     /// A set of filters specifying to which array elements an update should apply.
     ///
@@ -392,6 +405,7 @@ pub struct FindOneAndUpdateOptions {
 #[skip_serializing_none]
 #[serde(rename_all = "camelCase")]
 #[derive(Clone, Debug, Default, TypedBuilder, Serialize)]
+#[non_exhaustive]
 pub struct AggregateOptions {
     /// Enables writing to temporary files. When set to true, aggregation stages can write data to
     /// the _tmp subdirectory in the dbPath directory.
@@ -473,6 +487,7 @@ pub struct AggregateOptions {
 /// Specifies the options to a
 /// [`Collection::count_documents`](../struct.Collection.html#method.count_documents) operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct CountOptions {
     /// The index to use for the operation.
     #[builder(default)]
@@ -511,6 +526,7 @@ pub struct CountOptions {
 #[serde_with::skip_serializing_none]
 #[derive(Debug, Default, TypedBuilder, Serialize, Clone)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct EstimatedDocumentCountOptions {
     /// The maximum amount of time to allow the query to run.
     ///
@@ -540,6 +556,7 @@ pub struct EstimatedDocumentCountOptions {
 #[serde_with::skip_serializing_none]
 #[derive(Debug, Default, TypedBuilder, Serialize, Clone)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct DistinctOptions {
     /// The maximum amount of time to allow the query to run.
     ///
@@ -576,6 +593,7 @@ pub struct DistinctOptions {
 #[skip_serializing_none]
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct FindOptions {
     /// Enables writing to temporary files by the server. When set to true, the find operation can
     /// write data to the _tmp subdirectory in the dbPath directory. Only supported in server
@@ -741,6 +759,7 @@ where
 /// Specifies the options to a [`Collection::find_one`](../struct.Collection.html#method.find_one)
 /// operation.
 #[derive(Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct FindOneOptions {
     /// If true, partial results will be returned from a mongos rather than an error being
     /// returned if one or more shards is down.
@@ -820,6 +839,7 @@ pub struct FindOneOptions {
 
 /// Specifies an index to create.
 #[derive(Debug, TypedBuilder)]
+#[non_exhaustive]
 pub struct IndexModel {
     /// The fields to index, along with their sort order.
     pub keys: Document,
@@ -833,6 +853,7 @@ pub struct IndexModel {
 /// operation.
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct DropCollectionOptions {
     /// The write concern for the operation.
     #[builder(default)]

src/concern/mod.rs

@@ -128,6 +128,7 @@ impl Serialize for ReadConcernLevel {
 /// information about write concerns.
 #[skip_serializing_none]
 #[derive(Clone, Debug, Default, PartialEq, TypedBuilder, Serialize, Deserialize)]
+#[non_exhaustive]
 pub struct WriteConcern {
     /// Requests acknowledgement that the operation has propagated to a specific number or variety
     /// of servers.
@@ -155,6 +156,7 @@ pub struct WriteConcern {
 
 /// The type of the `w` field in a [`WriteConcern`](struct.WriteConcern.html).
 #[derive(Clone, Debug, PartialEq)]
+#[non_exhaustive]
 pub enum Acknowledgment {
     /// Requires acknowledgement that the write has reached the specified number of nodes.
     ///

src/db/options.rs

@@ -13,6 +13,7 @@ use crate::{
 /// These are the valid options for creating a [`Database`](../struct.Database.html) with
 /// [`Client::database_with_options`](../struct.Client.html#method.database_with_options).
 #[derive(Clone, Debug, Default, TypedBuilder)]
+#[non_exhaustive]
 pub struct DatabaseOptions {
     /// The default read preference for operations.
     #[builder(default)]
@@ -32,6 +33,7 @@ pub struct DatabaseOptions {
 #[skip_serializing_none]
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct CreateCollectionOptions {
     /// Whether the collection should be capped. If true, `size` must also be set.
     #[builder(default)]
@@ -94,6 +96,7 @@ pub struct CreateCollectionOptions {
 /// an update.
 #[derive(Debug, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub enum ValidationLevel {
     /// Perform no validation for inserts and updates.
     Off,
@@ -108,6 +111,7 @@ pub enum ValidationLevel {
 /// documents do not pass the validation.
 #[derive(Debug, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub enum ValidationAction {
     Error,
     Warn,
@@ -116,6 +120,7 @@ pub enum ValidationAction {
 /// Specifies the options to a [`Database::drop`](../struct.Database.html#method.drop) operation.
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct DropDatabaseOptions {
     /// The write concern for the operation.
     #[builder(default)]
@@ -125,6 +130,7 @@ pub struct DropDatabaseOptions {
 /// Specifies the options to a
 /// [`Database::list_collections`](../struct.Database.html#method.list_collections) operation.
 #[derive(Debug, Default, TypedBuilder, Serialize)]
+#[non_exhaustive]
 pub struct ListCollectionsOptions {
     /// The number of documents the server should return per cursor batch.
     ///
@@ -141,6 +147,7 @@ pub struct ListCollectionsOptions {
 /// [`Client::list_databases`](../struct.Client.html#method.list_databases) operation.
 #[derive(Debug, Default, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
+#[non_exhaustive]
 pub struct ListDatabasesOptions {
     /// Determines which databases to return based on the user's access privileges. This option is
     /// only supported on server versions 4.0.5+.