RUST-1748 Convert serde helpers to serde_with::(De)SerializeAs implementations for some converters between ObjectId, String, and DateTime (#559)

Author: JamieTsai1024

Cargo.toml

@@ -46,7 +46,7 @@ time-0_3 = []
 serde_path_to_error = ["dep:serde_path_to_error"]
 # if enabled, include serde_with interop.
 # should be used in conjunction with chrono-0_4 or uuid-0_8.
-serde_with-3 = ["dep:serde_with"]
+serde_with-3 = ["dep:serde_with", "dep:serde"]
 serde = ["dep:serde"]
 
 [lib]

README.md

@@ -229,15 +229,17 @@ provides a `DateTime` type, but its `Serialize` and `Deserialize` implementation
 instead, so when using it with BSON, the BSON datetime type is not used. To work around this, the
 `chrono-0_4` feature flag can be enabled. This flag exposes a number of convenient conversions
 between `bson::DateTime` and `chrono::DateTime`, including the
-[`chrono_datetime_as_bson_datetime`](https://docs.rs/bson/latest/bson/serde_helpers/chrono_datetime_as_bson_datetime/index.html)
+[`bson_datetime::FromChronoDateTime`](https://docs.rs/bson/latest/bson/serde_helpers/bson_datetime/struct.FromChronoDateTime/index.html)
 serde helper, which can be used to (de)serialize `chrono::DateTime`s to/from BSON datetimes, and the
 `From<chrono::DateTime>` implementation for `Bson`, which allows `chrono::DateTime` values to be
 used in the `doc!` and `bson!` macros.
 
 e.g.
 ``` rust
 use serde::{Serialize, Deserialize};
+use serde_with::serde_as;
 
+#[serde_as]
 #[derive(Serialize, Deserialize)]
 struct Foo {
     // serializes as a BSON datetime.
@@ -248,7 +250,7 @@ struct Foo {
 
     // serializes as a BSON datetime.
     // this requires the "chrono-0_4" feature flag
-    #[serde(with = "bson::serde_helpers::chrono_datetime_as_bson_datetime")]
+    #[serde_as(as = "bson::serde_helpers::bson_datetime::FromChronoDateTime")]
     chrono_as_bson: chrono::DateTime<chrono::Utc>,
 }
 

src/datetime.rs

@@ -110,16 +110,20 @@ use crate::error::{Error, Result};
 /// The `bson` crate provides a number of useful helpers for serializing and deserializing
 /// various datetime types to and from different formats. For example, to serialize a
 /// [`chrono::DateTime`] as a BSON datetime, you can use
-/// [`crate::serde_helpers::chrono_datetime_as_bson_datetime`]. Similarly, to serialize a BSON
-/// [`DateTime`] to a string, you can use [`crate::serde_helpers::bson_datetime_as_rfc3339_string`].
-/// Check out the [`crate::serde_helpers`] module documentation for a list of all of the helpers
-/// offered by the crate.
+/// [`crate::serde_helpers::bson_datetime::FromChronoDateTime`].
+/// Similarly, to serialize a BSON [`DateTime`] to a string, you can use
+/// [`crate::serde_helpers::bson_datetime::AsRfc3339String`]. Check out the
+/// [`crate::serde_helpers`] module documentation for a list of all of the helpers offered by the
+/// crate.
 ///
 /// ```rust
 /// # #[cfg(feature = "chrono-0_4")]
 /// # {
 /// use serde::{Serialize, Deserialize};
+/// use serde_with::serde_as;
+/// use bson::serde_helpers::bson_datetime;
 ///
+/// #[serde_as]
 /// #[derive(Serialize, Deserialize)]
 /// struct Foo {
 ///     // serializes as a BSON datetime.
@@ -130,11 +134,11 @@ use crate::error::{Error, Result};
 ///
 ///     // serializes as a BSON datetime.
 ///     // this requires the "chrono-0_4" feature flag
-///     #[serde(with = "bson::serde_helpers::chrono_datetime_as_bson_datetime")]
+///     #[serde_as(as = "bson_datetime::FromChronoDateTime")]
 ///     chrono_as_bson: chrono::DateTime<chrono::Utc>,
 ///
 ///     // serializes as an RFC 3339 / ISO-8601 string.
-///     #[serde(with = "bson::serde_helpers::bson_datetime_as_rfc3339_string")]
+///     #[serde_as(as = "bson_datetime::AsRfc3339String")]
 ///     bson_as_string: bson::DateTime,
 /// }
 /// # }

src/lib.rs

@@ -233,7 +233,7 @@
 //! on strings instead, so when using it with BSON, the BSON datetime type is not used. To work
 //! around this, the `chrono-0_4` feature flag can be enabled. This flag exposes a number of
 //! convenient conversions between [`bson::DateTime`](crate::DateTime) and [`chrono::DateTime`],
-//! including the [`serde_helpers::chrono_datetime_as_bson_datetime`]
+//! including the [`serde_helpers::bson_datetime::FromChronoDateTime`]
 //! serde helper, which can be used to (de)serialize [`chrono::DateTime`]s to/from BSON datetimes,
 //! and the `From<chrono::DateTime>` implementation for [`Bson`], which allows [`chrono::DateTime`]
 //! values to be used in the `doc!` and `bson!` macros.
@@ -243,8 +243,11 @@
 //! # #[cfg(feature = "chrono-0_4")]
 //! # {
 //! use serde::{Serialize, Deserialize};
+//! use serde_with::serde_as;
 //! use bson::doc;
+//! use bson::serde_helpers::bson_datetime;
 //!
+//! #[serde_as]
 //! #[derive(Serialize, Deserialize)]
 //! struct Foo {
 //!     // serializes as a BSON datetime.
@@ -255,7 +258,7 @@
 //!
 //!     // serializes as a BSON datetime.
 //!     // this requires the "chrono-0_4" feature flag
-//!     #[serde(with = "bson::serde_helpers::chrono_datetime_as_bson_datetime")]
+//!     #[serde_as(as = "bson_datetime::FromChronoDateTime")]
 //!     chrono_as_bson: chrono::DateTime<chrono::Utc>,
 //! }
 //!

src/oid.rs

@@ -62,22 +62,25 @@ static OID_COUNTER: Lazy<AtomicUsize> =
 /// The `bson` crate provides a number of useful helpers for serializing and deserializing
 /// various types to and from different formats. For example, to serialize an
 /// [`ObjectId`] as a hex string, you can use
-/// [`crate::serde_helpers::serialize_object_id_as_hex_string`].
+/// [`crate::serde_helpers::object_id::AsHexString`].
 /// Check out the [`crate::serde_helpers`] module documentation for a list of all of the helpers
 /// offered by the crate.
 ///
 /// e.g.
 /// ```rust
 /// use serde::{Serialize, Deserialize};
+/// use serde_with::serde_as;
 /// use bson::oid::ObjectId;
+/// use bson::serde_helpers::object_id;
 ///
+/// #[serde_as]
 /// #[derive(Serialize, Deserialize)]
 /// struct Foo {
 ///     // Serializes as a BSON ObjectId or extJSON in non-BSON formats
 ///     oid: ObjectId,
 ///
 ///     // Serializes as a hex string in all formats
-///     #[serde(serialize_with = "bson::serde_helpers::serialize_object_id_as_hex_string")]
+///     #[serde_as(as = "object_id::AsHexString")]
 ///     oid_as_hex: ObjectId,
 /// }
 /// # fn main() -> std::result::Result<(), Box<dyn std::error::Error>> {