fix rustdoc warnings, add to CI

Author: patrickfreed

.evergreen/config.yml

@@ -122,6 +122,16 @@ functions:
           ${PREPARE_SHELL}
           .evergreen/check-clippy.sh
 
+  "check rustdoc":
+    - command: shell.exec
+      type: test
+      params:
+        shell: bash
+        working_dir: "src"
+        script: |
+          ${PREPARE_SHELL}
+          .evergreen/check-rustdoc.sh
+
   "init test-results":
     - command: shell.exec
       params:
@@ -162,6 +172,10 @@ tasks:
     commands:
       - func: "check clippy"
 
+  - name: "check-rustdoc"
+    commands:
+      - func: "check rustdoc"
+
 axes:
   - id: "extra-rust-versions"
     values:
@@ -200,3 +214,4 @@ buildvariants:
   tasks:
     - name: "check-clippy"
     - name: "check-rustfmt"
+    - name: "check-rustdoc"

README.md

@@ -250,12 +250,12 @@ let query = doc! {
 The BSON format does not contain a dedicated UUID type, though it does have a "binary" type which
 has UUID subtypes. Accordingly, this crate provides a
 [`Binary`](https://docs.rs/bson/latest/bson/struct.Binary.html) struct which models this binary type
-and serializes to and deserializes from it. The popular [`uuid`](https://docs.rs/uuid) crate does provide a UUID type
-(`Uuid`), though its `Serialize` and `Deserialize` implementations operate on strings, so when using
-it with BSON, the BSON binary type will not be used. To facilitate the conversion between `Uuid`
-values and BSON binary values, the `uuid-0_8` feature flag can be enabled. This flag exposes a
-number of convenient conversions from `Uuid`, including the
-[`uuid_as_bson_binary`](https://docs.rs/bson/2.0.0-beta.3/bson/serde_helpers/uuid_as_binary/index.html)
+and serializes to and deserializes from it. The popular [`uuid`](https://docs.rs/uuid) crate does
+provide a UUID type (`Uuid`), though its `Serialize` and `Deserialize` implementations operate on
+strings, so when using it with BSON, the BSON binary type will not be used. To facilitate the
+conversion between `Uuid` values and BSON binary values, the `uuid-0_8` feature flag can be
+enabled. This flag exposes a number of convenient conversions from `Uuid`, including the
+[`uuid_as_binary`](https://docs.rs/bson/2.0.0-beta.3/bson/serde_helpers/uuid_as_binary/index.html)
 serde helper, which can be used to (de)serialize `Uuid`s to/from BSON binaries with the UUID
 subtype, and the `From<Uuid>` implementation for `Bson`, which allows `Uuid` values to be used in
 the `doc!` and `bson!` macros.

src/datetime.rs

@@ -30,7 +30,7 @@ use chrono::{LocalResult, TimeZone, Utc};
 /// will serialize to and deserialize from that format's equivalent of the
 /// [extended JSON representation](https://docs.mongodb.com/manual/reference/mongodb-extended-json/) of a datetime.
 /// To serialize a [`chrono::DateTime`] as a BSON datetime, you can use
-/// [`serde_helpers::chrono_datetime_as_bson_datetime`].
+/// [`crate::serde_helpers::chrono_datetime_as_bson_datetime`].
 ///
 /// ```rust
 /// # #[cfg(feature = "chrono-0_4")]
@@ -125,7 +125,7 @@ impl crate::DateTime {
         self.to_chrono_private()
     }
 
-    /// Convert the given [`std::SystemTime`] to a [`DateTime`].
+    /// Convert the given [`std::time::SystemTime`] to a [`DateTime`].
     ///
     /// If the provided time is too far in the future or too far in the past to be represented
     /// by a BSON datetime, either [`DateTime::MAX`] or [`DateTime::MIN`] will be
@@ -151,7 +151,7 @@ impl crate::DateTime {
         }
     }
 
-    /// Convert this [`DateTime`] to a [`std::SystemTime`].
+    /// Convert this [`DateTime`] to a [`std::time::SystemTime`].
     pub fn to_system_time(self) -> SystemTime {
         if self.0 >= 0 {
             SystemTime::UNIX_EPOCH + Duration::from_millis(self.0 as u64)

src/de/error.rs

@@ -30,7 +30,7 @@ pub enum Error {
     EndOfStream,
 
     /// A general error encountered during deserialization.
-    /// See: https://docs.serde.rs/serde/de/trait.Error.html
+    /// See: <https://docs.serde.rs/serde/de/trait.Error.html>
     #[non_exhaustive]
     DeserializationError {
         /// A message describing the error.

src/de/mod.rs

@@ -423,7 +423,7 @@ where
 /// sequences with the Unicode replacement character.
 ///
 /// This is mainly useful when reading raw BSON returned from a MongoDB server, which
-/// in rare cases can contain invalidly truncated strings (https://jira.mongodb.org/browse/SERVER-24007).
+/// in rare cases can contain invalidly truncated strings (<https://jira.mongodb.org/browse/SERVER-24007>).
 /// For most use cases, [`crate::from_reader`] can be used instead.
 pub fn from_reader_utf8_lossy<R, T>(reader: R) -> Result<T>
 where
@@ -447,7 +447,7 @@ where
 /// sequences with the Unicode replacement character.
 ///
 /// This is mainly useful when reading raw BSON returned from a MongoDB server, which
-/// in rare cases can contain invalidly truncated strings (https://jira.mongodb.org/browse/SERVER-24007).
+/// in rare cases can contain invalidly truncated strings (<https://jira.mongodb.org/browse/SERVER-24007>).
 /// For most use cases, [`crate::from_slice`] can be used instead.
 pub fn from_slice_utf8_lossy<'de, T>(bytes: &'de [u8]) -> Result<T>
 where

src/document.rs

@@ -607,7 +607,7 @@ impl Document {
     /// stream.
     ///
     /// This is mainly useful when reading raw BSON returned from a MongoDB server, which
-    /// in rare cases can contain invalidly truncated strings (https://jira.mongodb.org/browse/SERVER-24007).
+    /// in rare cases can contain invalidly truncated strings (<https://jira.mongodb.org/browse/SERVER-24007>).
     /// For most use cases, `Document::from_reader` can be used instead.
     pub fn from_reader_utf8_lossy<R: Read>(mut reader: R) -> crate::de::Result<Document> {
         Self::decode(&mut reader, true)

src/extjson/de.rs

@@ -35,7 +35,7 @@ pub enum Error {
     InvalidObjectId(oid::Error),
 
     /// A general error encountered during deserialization.
-    /// See: https://docs.serde.rs/serde/de/trait.Error.html
+    /// See: <https://docs.serde.rs/serde/de/trait.Error.html>
     DeserializationError { message: String },
 }
 

src/lib.rs

@@ -213,7 +213,7 @@
 //! ## Working with datetimes
 //!
 //! The BSON format includes a datetime type, which is modeled in this crate by the
-//! [`bson::DateTime`] struct, and the
+//! [`DateTime`] struct, and the
 //! `Serialize` and `Deserialize` implementations for this struct produce and parse BSON datetimes
 //! when serializing to or deserializing from BSON. The popular crate [`chrono`](docs.rs/chrono)
 //! also provides a `DateTime` type, but its `Serialize` and `Deserialize` implementations operate
@@ -262,7 +262,7 @@
 //! using it with BSON, the BSON binary type will not be used. To facilitate the conversion between
 //! `Uuid` values and BSON binary values, the `uuid-0_8` feature flag can be enabled. This flag
 //! exposes a number of convenient conversions from `Uuid`, including the
-//! [`serde_helpers::uuid_as_bson_binary`]
+//! [`serde_helpers::uuid_as_binary`]
 //! serde helper, which can be used to (de)serialize `Uuid`s to/from BSON binaries with the UUID
 //! subtype, and the `From<Uuid>` implementation for `Bson`, which allows `Uuid` values to be used
 //! in the `doc!` and `bson!` macros.

src/ser/error.rs

@@ -15,7 +15,7 @@ pub enum Error {
     InvalidDocumentKey(Bson),
 
     /// A general error that occurred during serialization.
-    /// See: https://docs.rs/serde/1.0.110/serde/ser/trait.Error.html#tymethod.custom
+    /// See: <https://docs.rs/serde/1.0.110/serde/ser/trait.Error.html#tymethod.custom>
     #[non_exhaustive]
     SerializationError {
         /// A message describing the error.