Struct DateTime 

pub struct DateTime {
    pub year: i32,
    pub month: i32,
    pub day: i32,
    pub hours: i32,
    pub minutes: i32,
    pub seconds: i32,
    pub nanos: i32,
    pub time_offset: Option<TimeOffset>,
}

Available on crate feature datetime only.

Represents civil time (or occasionally physical time).

This type can represent a civil time in one of a few possible ways:

• When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
• When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.
• When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time.

The date is relative to the Proleptic Gregorian Calendar.

If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values.

This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field.

This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations.

Fields

year: i32

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

month: i32

Required. Month of year. Must be from 1 to 12.

day: i32

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

hours: i32

Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

minutes: i32

Required. Minutes of hour of day. Must be from 0 to 59.

seconds: i32

Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

nanos: i32

Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

time_offset: Option<TimeOffset>

Optional. Specifies either the UTC offset or the time zone of the DateTime. Choose carefully between them, considering that time zone data may change in the future (for example, a country modifies their DST start/end dates, and future DateTimes in the affected range had already been stored). If omitted, the DateTime is considered to be in local time.

Implementations

impl DateTime

pub fn validate(&self) -> Result<(), DateTimeError>

Checks if this DateTime instance represents a valid date and time, and returns the related error if it does not.

pub fn is_valid(&self) -> bool

Checks if this DateTime instance represents a valid date and time.

pub fn has_year(&self) -> bool

Returns true if the DateTime has a specific year (i.e., year is not 0).

pub fn has_utc_offset(&self) -> bool

Returns true if the TimeOffset is a UtcOffset.

pub fn has_timezone(&self) -> bool

Returns true if the TimeOffset is a TimeZone.

pub fn is_local(&self) -> bool

Returns true if the TimeOffset is None.

pub fn with_utc_offset(self, offset: Duration) -> Self

Sets the time_offset to a UTC offset Duration, clearing any existing time zone.

pub fn with_time_zone(self, time_zone: TimeZone) -> Self

Sets the time_offset to a TimeZone, clearing any existing UTC offset.

pub fn to_datetime_utc(self) -> Result<DateTime<Utc>, DateTimeError>

Available on crate feature chrono only.

Converts this DateTime to chrono::DateTime. It succeeds if the TimeOffset is a UtcOffset with 0 seconds and nanos.

pub fn to_fixed_offset_datetime( self, ) -> Result<DateTime<FixedOffset>, DateTimeError>

Available on crate feature chrono only.

Converts this DateTime to chrono::DateTime<FixedOffset>. It succeeds if the TimeOffset is a UtcOffset that results in an unambiguous FixedOffset.

pub fn to_datetime_with_tz(self) -> Result<DateTime<Tz>, DateTimeError>

Available on crate features chrono and chrono-tz only.

Converts this DateTime to chrono::DateTime<Tz>. It succeeds if the TimeOffset is a TimeZone that maps to a valid Tz or if the TimeOffset is a UtcOffset with 0 seconds and nanos.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a duplicate 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 Default for DateTime

fn default() -> Self

Returns the “default value” for a type.

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

Available on crate feature serde only.

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<Tz>> for DateTime

Available on crate features chrono and chrono-tz only.

fn from(value: DateTime<Tz>) -> Self

Converts to this type from the input type.

impl From<DateTime<Utc>> for DateTime

Available on crate feature chrono only.

fn from(value: DateTime<Utc>) -> Self

Converts to this type from the input type.

impl From<NaiveDateTime> for DateTime

Available on crate feature chrono only.

fn from(ndt: NaiveDateTime) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for DateTime

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DateTime

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DateTime

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for DateTime

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DateTime> for DateTime<FixedOffset>

Available on crate feature chrono only.

type Error = DateTimeError

The type returned in the event of a conversion error.

fn try_from(value: DateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DateTime> for DateTime<Tz>

Available on crate features chrono and chrono-tz only.

type Error = DateTimeError

The type returned in the event of a conversion error.

fn try_from(value: DateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DateTime> for DateTime<Utc>

Available on crate feature chrono only.

type Error = DateTimeError

The type returned in the event of a conversion error.

fn try_from(value: DateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DateTime> for NaiveDateTime

Available on crate feature chrono only.

type Error = DateTimeError

The type returned in the event of a conversion error.

fn try_from(dt: DateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DateTime> for Value

Available on crate feature cel only.

type Error = CelConversionError

The type returned in the event of a conversion error.

fn try_from(value: DateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DateTime

impl StructuralPartialEq for DateTime