RUST-765 Ensure API meets Rust API guidelines #255
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,10 +21,7 @@ | |
|
|
||
| //! BSON definition | ||
|
|
||
| use std::fmt::{self, Debug, Display}; | ||
|
|
||
| use chrono::{Datelike, SecondsFormat, TimeZone, Utc}; | ||
| use serde_json::{json, Value}; | ||
|
|
@@ -68,7 +65,7 @@ pub enum Bson { | |
| /// [ObjectId](http://dochub.mongodb.org/core/objectids) | ||
| ObjectId(oid::ObjectId), | ||
| /// UTC datetime | ||
| DateTime(crate::DateTime), | ||
| /// Symbol (Deprecated) | ||
| Symbol(String), | ||
| /// [128-bit decimal floating point](https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.rst) | ||
|
|
@@ -278,7 +275,7 @@ impl From<u64> for Bson { | |
|
|
||
| impl From<[u8; 12]> for Bson { | ||
| fn from(a: [u8; 12]) -> Bson { | ||
| Bson::ObjectId(oid::ObjectId::from_bytes(a)) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -290,7 +287,7 @@ impl From<oid::ObjectId> for Bson { | |
|
|
||
| impl From<chrono::DateTime<Utc>> for Bson { | ||
| fn from(a: chrono::DateTime<Utc>) -> Bson { | ||
| Bson::DateTime(DateTime(a)) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -373,15 +370,15 @@ impl Bson { | |
| }) | ||
| } | ||
| Bson::ObjectId(v) => json!({"$oid": v.to_hex()}), | ||
| Bson::DateTime(v) if v.timestamp_millis() >= 0 && v.0.year() <= 99999 => { | ||
| let seconds_format = if v.0.timestamp_subsec_millis() == 0 { | ||
| SecondsFormat::Secs | ||
| } else { | ||
| SecondsFormat::Millis | ||
| }; | ||
|
|
||
| json!({ | ||
| "$date": v.0.to_rfc3339_opts(seconds_format, true), | ||
| }) | ||
| } | ||
| Bson::DateTime(v) => json!({ | ||
|
|
@@ -539,15 +536,15 @@ impl Bson { | |
| "$oid": v.to_string(), | ||
| } | ||
| } | ||
| Bson::DateTime(v) if v.timestamp_millis() >= 0 && v.0.year() <= 99999 => { | ||
| let seconds_format = if v.0.timestamp_subsec_millis() == 0 { | ||
| SecondsFormat::Secs | ||
| } else { | ||
| SecondsFormat::Millis | ||
| }; | ||
|
|
||
| doc! { | ||
| "$date": v.0.to_rfc3339_opts(seconds_format, true), | ||
| } | ||
| } | ||
| Bson::DateTime(v) => doc! { | ||
|
|
@@ -607,7 +604,7 @@ impl Bson { | |
| match keys.as_slice() { | ||
| ["$oid"] => { | ||
| if let Ok(oid) = doc.get_str("$oid") { | ||
| if let Ok(oid) = ObjectId::parse_str(oid) { | ||
| return Bson::ObjectId(oid); | ||
| } | ||
| } | ||
|
|
@@ -738,12 +735,12 @@ impl Bson { | |
|
|
||
| ["$date"] => { | ||
| if let Ok(date) = doc.get_i64("$date") { | ||
| return Bson::DateTime(DateTime::from_millis(date)); | ||
| } | ||
|
|
||
| if let Ok(date) = doc.get_str("$date") { | ||
| if let Ok(date) = chrono::DateTime::parse_from_rfc3339(date) { | ||
| return Bson::DateTime(date.with_timezone(&Utc).into()); | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -888,7 +885,7 @@ impl Bson { | |
| } | ||
|
|
||
| /// If `Bson` is `DateTime`, return its value. Returns `None` otherwise | ||
| pub fn as_datetime(&self) -> Option<&crate::DateTime> { | ||
| match *self { | ||
| Bson::DateTime(ref v) => Some(v), | ||
| _ => None, | ||
|
|
@@ -897,7 +894,7 @@ impl Bson { | |
|
|
||
| /// If `Bson` is `DateTime`, return a mutable reference to its value. Returns `None` | ||
| /// otherwise | ||
| pub fn as_datetime_mut(&mut self) -> Option<&mut crate::DateTime> { | ||
| match *self { | ||
| Bson::DateTime(ref mut v) => Some(v), | ||
| _ => None, | ||
|
|
@@ -973,76 +970,78 @@ impl Timestamp { | |
| } | ||
| } | ||
|
|
||
| /// Struct representing a BSON datetime. | ||
| /// | ||
| /// Is is recommended to use a [`chrono::DateTime`] for date operations | ||
| /// and to convert it to/from a [`crate::DateTime`] via the `From`/`Into` implementations. | ||
| /// | ||
| /// ``` | ||
| /// use chrono::prelude::*; | ||
| /// # fn main() -> std::result::Result<(), Box<dyn std::error::Error>> { | ||
| /// let chrono_dt: chrono::DateTime<Utc> = "2014-11-28T12:00:09Z".parse()?; | ||
| /// let bson_dt: bson::DateTime = chrono_dt.into(); | ||
| /// let back_to_chrono: chrono::DateTime<Utc> = bson_dt.into(); | ||
| /// # Ok(()) | ||
| /// # } | ||
| /// ``` | ||
| /// | ||
| /// This type differs from [`chrono::DateTime`] in that it serializes to and deserializes from a | ||
| /// BSON datetime rather than an ISO-8601 formatted string. This means that in non-BSON formats, it | ||
| /// 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_0_4_datetime_as_bson_datetime`]. | ||
| /// | ||
| /// ```rust | ||
| /// use serde::{Serialize, Deserialize}; | ||
| /// | ||
| /// #[derive(Serialize, Deserialize)] | ||
| /// struct Foo { | ||
| /// // serializes as a BSON datetime. | ||
| /// date_time: bson::DateTime, | ||
| /// | ||
| /// // serializes as an ISO-8601 string. | ||
| /// chrono_datetime: chrono::DateTime<chrono::Utc>, | ||
| /// | ||
| /// // serializes as a BSON datetime. | ||
| /// #[serde(with = "bson::serde_helpers::chrono_0_4_datetime_as_bson_datetime")] | ||
| /// chrono_as_bson: chrono::DateTime<chrono::Utc>, | ||
| /// } | ||
| /// ``` | ||
| #[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Copy, Clone)] | ||
| pub struct DateTime(chrono::DateTime<Utc>); | ||
|
|
||
| impl crate::DateTime { | ||
| pub(crate) fn from_millis(date: i64) -> Self { | ||
|
There was a problem hiding this comment. I thought about making this public, but apparently too-large values here can cause panics (RUST-799), so I just left it private for now until we decide how / if we want to tackle this publicly. |
||
| Utc.timestamp_millis(date).into() | ||
| } | ||
|
|
||
| /// Returns the number of non-leap-milliseconds since January 1, 1970 UTC. | ||
| pub fn timestamp_millis(&self) -> i64 { | ||
| self.0.timestamp_millis() | ||
| } | ||
|
|
||
| /// If this DateTime is sub-millisecond precision. BSON only supports millisecond precision, so | ||
| /// this should be checked before serializing to BSON. | ||
| pub(crate) fn is_sub_millis_precision(&self) -> bool { | ||
| self.0.timestamp_subsec_micros() % 1000 != 0 | ||
| } | ||
| } | ||
|
|
||
| impl Display for crate::DateTime { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| Display::fmt(&self.0, f) | ||
| } | ||
| } | ||
|
|
||
| impl From<crate::DateTime> for chrono::DateTime<Utc> { | ||
| fn from(utc: DateTime) -> Self { | ||
| utc.0 | ||
| } | ||
| } | ||
|
|
||
| impl<T: chrono::TimeZone> From<chrono::DateTime<T>> for crate::DateTime { | ||
|
There was a problem hiding this comment. I updated this to be more general since it could be a little annoying to convert from |
||
| fn from(x: chrono::DateTime<T>) -> Self { | ||
| DateTime(x.with_timezone(&Utc)) | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.