fix: add in mod wrapper to silence warning: rust-lang/rust#83583

Author: fscc-alexkornitzer

mongod/src/field.rs

@@ -5,6 +5,7 @@
 /// Defining an `enum` as a set of fields for use in a mongo query.
 ///
 /// ```
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 /// use mongod::Field;
 ///
@@ -27,6 +28,7 @@
 ///         }
 ///     }
 /// }
+/// # }
 /// ```
 pub trait Field {}
 
@@ -37,6 +39,7 @@ pub trait Field {}
 /// Defining an `enum` as a set of fields for use in a mongo query.
 ///
 /// ```
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 /// use mongod::{AsField, Field};
 ///
@@ -61,5 +64,6 @@ pub trait Field {}
 ///         }
 ///     }
 /// }
+/// # }
 /// ```
 pub trait AsField<F: Field + Into<String>> {}

mongod/src/filter.rs

@@ -84,6 +84,7 @@ where
 /// Tying `User` to its `Filter`.
 ///
 /// ```
+/// # mod wrapper {
 /// use std::convert::TryFrom;
 ///
 /// # use mongod_derive::{Bson, Mongo};
@@ -127,6 +128,7 @@ where
 ///         }
 ///     }
 /// }
+/// # }
 /// ```
 pub trait AsFilter<T: Filter> {
     /// Returns the `Collection`s filter.

mongod/src/lib.rs

@@ -17,6 +17,7 @@
 //! Defining an example collection using derive.
 //!
 //! ```
+//! # mod wrapper {
 //! # use mongod_derive::{Bson, Mongo};
 //! #[derive(Bson, Mongo)]
 //! #[mongo(collection="users", field, filter, update)]
@@ -25,6 +26,7 @@
 //!     age: Option<u32>,
 //!     email: Option<String>,
 //! }
+//! # }
 //! ```
 //!
 //! ## Making requests
@@ -43,6 +45,7 @@
 //! Deleting a user from the users collection.
 //!
 //! ```no_run
+//! # mod wrapper {
 //! # use mongod_derive::{Bson, Mongo};
 //! # #[derive(Bson, Mongo)]
 //! # #[mongo(collection="users", field, filter, update)]
@@ -63,13 +66,15 @@
 //! println!("delete {} documents", deleted);
 //! # Ok(())
 //! # }
+//! # }
 //! ```
 //!
 //! ### Fetching
 //!
 //! Fetching users from the users collection.
 //!
 //! ```no_run
+//! # mod wrapper {
 //! # use std::convert::TryFrom;
 //! # use mongod_derive::{Bson, Mongo};
 //! use bson::Document;
@@ -95,13 +100,15 @@
 //! }
 //! # Ok(())
 //! # }
+//! # }
 //! ```
 //!
 //!T ### Inserting
 //!
 //! Inserting a user into the users collection.
 //!
 //! ```no_run
+//! # mod wrapper {
 //! # use mongod_derive::{Bson, Mongo};
 //! # #[derive(Debug, Bson, Mongo)]
 //! # #[mongo(collection="users", field, filter, update)]
@@ -123,13 +130,15 @@
 //! println!("(index: oid) {:?}", result);
 //! # Ok(())
 //! # }
+//! # }
 //! ```
 //!
 //! ### Replacing
 //!
 //! Replacing a user in the users collection.
 //!
 //! ```no_run
+//! # mod wrapper {
 //! # use mongod_derive::{Bson, Mongo};
 //! # #[derive(Debug, Bson, Mongo)]
 //! # #[mongo(collection="users", field, filter, update)]
@@ -156,13 +165,15 @@
 //! println!("{:?}", oid);
 //! # Ok(())
 //! # }
+//! # }
 //! ```
 //!
 //! ### Updating
 //!
 //! Updating a user in the users collection.
 //!
 //! ```no_run
+//! # mod wrapper {
 //! # use mongod_derive::{Bson, Mongo};
 //! # #[derive(Debug, Bson, Mongo)]
 //! # #[mongo(collection="users", field, filter, update)]
@@ -191,6 +202,7 @@
 //! println!("updated {} documents", updated);
 //! # Ok(())
 //! # }
+//! # }
 //! ```
 //!
 //! ## Optional Features

mongod/src/query/delete.rs

@@ -14,7 +14,7 @@ use bson::Document;
 /// Delete all documents from a collection.
 ///
 /// ```no_run
-/// # async fn doc() -> Result<(), mongod::Error> {
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 ///
 /// #[derive(Bson, Mongo)]
@@ -23,6 +23,7 @@ use bson::Document;
 ///     name: String,
 /// }
 ///
+/// # async fn doc() -> Result<(), mongod::Error> {
 /// let client = mongod::Client::new();
 ///
 /// let deleted = mongod::query::Delete::<User>::new()
@@ -33,6 +34,7 @@ use bson::Document;
 /// println!("delete {} documents", deleted);
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 #[derive(Clone)]
 pub struct Delete<C: Collection> {

mongod/src/query/find.rs

@@ -17,7 +17,7 @@ use crate::sort::Sort;
 /// Find all documents from a collection.
 ///
 /// ```no_run
-/// # async fn doc() -> Result<(), mongod::Error> {
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 ///
 /// use futures::stream::StreamExt;
@@ -30,6 +30,7 @@ use crate::sort::Sort;
 ///     name: String,
 /// }
 ///
+/// # async fn doc() -> Result<(), mongod::Error> {
 /// let client = mongod::Client::new();
 ///
 /// let mut cursor = mongod::query::Find::<User>::new()
@@ -43,6 +44,7 @@ use crate::sort::Sort;
 /// }
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 #[derive(Clone)]
 pub struct Find<C: Collection> {

mongod/src/query/insert.rs

@@ -14,7 +14,7 @@ use crate::r#async::Client;
 /// Insert a document into a collection.
 ///
 /// ```no_run
-/// # async fn doc() -> Result<(), mongod::Error> {
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 /// use serde::{Deserialize, Serialize};
 ///
@@ -24,6 +24,7 @@ use crate::r#async::Client;
 ///     name: String,
 /// }
 ///
+/// # async fn doc() -> Result<(), mongod::Error> {
 /// let client = mongod::Client::new();
 ///
 /// let user = User { name: "foo".to_owned() };
@@ -36,6 +37,7 @@ use crate::r#async::Client;
 /// println!("(index: oid) {:?}", result);
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 #[derive(Clone)]
 pub struct Insert<C: Collection> {

mongod/src/query/replace.rs

@@ -14,7 +14,7 @@ use crate::r#async::Client;
 /// Replace a document in a collection.
 ///
 /// ```no_run
-/// # async fn doc() -> Result<(), mongod::Error> {
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 ///
 /// use mongod::{AsFilter, Comparator};
@@ -26,6 +26,7 @@ use crate::r#async::Client;
 ///     name: String,
 /// }
 ///
+/// # async fn doc() -> Result<(), mongod::Error> {
 /// let client = mongod::Client::new();
 ///
 /// let mut filter = User::filter();
@@ -44,6 +45,7 @@ use crate::r#async::Client;
 /// println!("{:?}", oid);
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 #[derive(Clone)]
 pub struct Replace<C: Collection> {

mongod/src/query/update.rs

@@ -15,6 +15,7 @@ use crate::update::{AsUpdate, Updates};
 /// Updates some documents in a collection.
 ///
 /// ```no_run
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 /// use serde::{Deserialize, Serialize};
 ///
@@ -25,9 +26,9 @@ use crate::update::{AsUpdate, Updates};
 ///     age: Option<u32>,
 ///     email: Option<String>,
 /// }
-/// # async fn doc() -> Result<(), mongod::Error> {
 /// use mongod::{AsFilter, Comparator, AsUpdate};
 ///
+/// # async fn doc() -> Result<(), mongod::Error> {
 /// let client = mongod::Client::new();
 ///
 /// let mut filter = User::filter();
@@ -51,6 +52,7 @@ use crate::update::{AsUpdate, Updates};
 /// println!("updated {} documents", updated);
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 ///
 #[derive(Clone)]

mongod/src/sort.rs

@@ -40,7 +40,7 @@ where
 /// Sorting a user collection by name.
 ///
 /// ```no_run
-/// # async fn doc() -> Result<(), mongod::Error> {
+/// # mod wrapper {
 /// use mongod::bson::Document;
 /// use mongod::{AsField, Field, Order, Query, Sort};
 /// use serde::{Deserialize, Serialize};
@@ -68,6 +68,7 @@ where
 ///     }
 /// }
 ///
+/// # async fn doc() -> Result<(), mongod::Error> {
 /// let client = mongod::Client::default();
 ///
 /// let mut sort = Sort::new();
@@ -80,6 +81,7 @@ where
 ///     .unwrap();
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 #[derive(Clone, Serialize)]
 pub struct Sort<T: Field + Into<String>>(Vec<(T, Order<T>)>);

mongod/src/update.rs

@@ -9,6 +9,7 @@ use crate::error::Error;
 /// Tying `User` to its `Update`.
 ///
 /// ```
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 /// use mongod::bson::Document;
 /// use mongod::{AsUpdate, Error, Update};
@@ -48,6 +49,7 @@ use crate::error::Error;
 ///         }
 ///     }
 /// }
+/// # }
 /// ```
 pub trait AsUpdate<U: Update> {
     /// Returns the `Collection`s update.
@@ -102,6 +104,7 @@ pub trait Update {
 /// Unset the age of a user.
 ///
 /// ```no_run
+/// # mod wrapper {
 /// # use mongod_derive::{Bson, Mongo};
 /// use mongod::bson::Document;
 /// use mongod::{AsFilter, AsUpdate, Comparator, Error, Update, Updates};
@@ -168,6 +171,7 @@ pub trait Update {
 /// let _cursor = client.update::<User, _, _>(filter, updates).await.unwrap();
 /// # Ok(())
 /// # }
+/// # }
 /// ```
 // TODO: Implement the other update operators: https://docs.mongodb.com/manual/reference/operator/update/#id1
 #[derive(Default)]