Struct bson::DateTime

pub struct DateTime(_);

Struct representing a BSON datetime. Note: BSON datetimes have millisecond precision.

To enable conversions between this type and chrono::DateTime, enable the "chrono-0_4" feature flag in your Cargo.toml.

use chrono::prelude::*;
let chrono_dt: chrono::DateTime<Utc> = "2014-11-28T12:00:09Z".parse()?;
let bson_dt: bson::DateTime = chrono_dt.into();
let bson_dt = bson::DateTime::from_chrono(chrono_dt);
let back_to_chrono: chrono::DateTime<Utc> = bson_dt.into();
let back_to_chrono = bson_dt.to_chrono();

This type differs from chrono::DateTime in that it serializes to and deserializes from a BSON datetime rather than an RFC 3339 formatted string. Additionally, in non-BSON formats, it will serialize to and deserialize from that format’s equivalent of the extended JSON representation of a datetime. To serialize a chrono::DateTime as a BSON datetime, you can use [serde_helpers::chrono_datetime_as_bson_datetime].

use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize)]
struct Foo {
    // serializes as a BSON datetime.
    date_time: bson::DateTime,

    // serializes as an RFC 3339 / ISO-8601 string.
    chrono_datetime: chrono::DateTime<chrono::Utc>,

    // serializes as a BSON datetime.
    // this requires the "chrono-0_4" feature flag
    #[serde(with = "bson::serde_helpers::chrono_datetime_as_bson_datetime")]
    chrono_as_bson: chrono::DateTime<chrono::Utc>,
}

Implementations

impl DateTime

pub const MAX: Self

The latest possible date that can be represented in BSON.

pub const MIN: Self

The earliest possible date that can be represented in BSON.

pub const fn from_millis(date: i64) -> Self

Makes a new DateTime from the number of non-leap milliseconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”).

pub fn now() -> DateTime

Returns a DateTime which corresponds to the current date and time.

pub fn from_system_time(st: SystemTime) -> Self

Convert the given [std::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 returned, whichever is closer.

pub fn to_system_time(self) -> SystemTime

Convert this DateTime to a [std::SystemTime].

pub const fn timestamp_millis(self) -> i64

Returns the number of non-leap-milliseconds since January 1, 1970 UTC.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DateTime

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DateTime

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for DateTime

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<DateTime> for Bson

fn from(dt: DateTime) -> Self

Performs the conversion.

impl From<DateTime> for SystemTime

fn from(dt: DateTime) -> Self

Performs the conversion.

impl From<SystemTime> for DateTime

fn from(st: SystemTime) -> Self

Performs the conversion.

impl Hash for DateTime

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for DateTime

fn cmp(&self, other: &DateTime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DateTime> for DateTime

fn eq(&self, other: &DateTime) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DateTime) -> bool

This method tests for !=.

impl PartialOrd<DateTime> for DateTime

fn partial_cmp(&self, other: &DateTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DateTime

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for DateTime

impl Eq for DateTime

impl StructuralEq for DateTime

impl StructuralPartialEq for DateTime