pub struct DateTime<Tz: TimeZone> { /* private fields */ }
Expand description
ISO 8601 combined date and time with time zone.
There are some constructors implemented here (the from_*
methods), but
the general-purpose constructors are all via the methods on the
TimeZone
implementations.
Implementations§
source§impl<Tz: TimeZone> DateTime<Tz>
impl<Tz: TimeZone> DateTime<Tz>
sourcepub fn from_utc(datetime: NaiveDateTime, offset: Tz::Offset) -> DateTime<Tz>
pub fn from_utc(datetime: NaiveDateTime, offset: Tz::Offset) -> DateTime<Tz>
Makes a new DateTime
with given UTC datetime and offset.
The local datetime should be constructed via the TimeZone
trait.
Example
use chrono::{DateTime, TimeZone, NaiveDateTime, Utc};
let dt = DateTime::<Utc>::from_utc(NaiveDateTime::from_timestamp_opt(61, 0).unwrap(), Utc);
assert_eq!(Utc.timestamp_opt(61, 0).unwrap(), dt);
sourcepub fn from_local(datetime: NaiveDateTime, offset: Tz::Offset) -> DateTime<Tz>
pub fn from_local(datetime: NaiveDateTime, offset: Tz::Offset) -> DateTime<Tz>
Makes a new DateTime
with given local datetime and offset that
presents local timezone.
Example
use chrono::DateTime;
use chrono::naive::NaiveDate;
use chrono::offset::{Utc, FixedOffset};
let naivedatetime_utc = NaiveDate::from_ymd_opt(2000, 1, 12).unwrap().and_hms_opt(2, 0, 0).unwrap();
let datetime_utc = DateTime::<Utc>::from_utc(naivedatetime_utc, Utc);
let timezone_east = FixedOffset::east_opt(8 * 60 * 60).unwrap();
let naivedatetime_east = NaiveDate::from_ymd_opt(2000, 1, 12).unwrap().and_hms_opt(10, 0, 0).unwrap();
let datetime_east = DateTime::<FixedOffset>::from_local(naivedatetime_east, timezone_east);
let timezone_west = FixedOffset::west_opt(7 * 60 * 60).unwrap();
let naivedatetime_west = NaiveDate::from_ymd_opt(2000, 1, 11).unwrap().and_hms_opt(19, 0, 0).unwrap();
let datetime_west = DateTime::<FixedOffset>::from_local(naivedatetime_west, timezone_west);
assert_eq!(datetime_east, datetime_utc.with_timezone(&timezone_east));
assert_eq!(datetime_west, datetime_utc.with_timezone(&timezone_west));
sourcepub fn date(&self) -> Date<Tz>
👎Deprecated since 0.4.23: Use date_naive()
instead
pub fn date(&self) -> Date<Tz>
date_naive()
insteadRetrieves a date component
Unless you are immediately planning on turning this into a DateTime
with the same Timezone you should use the
date_naive
method.
sourcepub fn date_naive(&self) -> NaiveDate
pub fn date_naive(&self) -> NaiveDate
Retrieves the Date without an associated timezone
NaiveDate
is a more well-defined type, and has more traits implemented on it,
so should be preferred to Date
any time you truly want to operate on Dates.
use chrono::prelude::*;
let date: DateTime<Utc> = Utc.with_ymd_and_hms(2020, 1, 1, 0, 0, 0).unwrap();
let other: DateTime<FixedOffset> = FixedOffset::east_opt(23).unwrap().with_ymd_and_hms(2020, 1, 1, 0, 0, 0).unwrap();
assert_eq!(date.date_naive(), other.date_naive());
sourcepub fn time(&self) -> NaiveTime
pub fn time(&self) -> NaiveTime
Retrieves a time component.
Unlike date
, this is not associated to the time zone.
sourcepub fn timestamp(&self) -> i64
pub fn timestamp(&self) -> i64
Returns the number of non-leap seconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”).
sourcepub fn timestamp_millis(&self) -> i64
pub fn timestamp_millis(&self) -> i64
Returns the number of non-leap-milliseconds since January 1, 1970 UTC
Note that this does reduce the number of years that can be represented from ~584 Billion to ~584 Million. (If this is a problem, please file an issue to let me know what domain needs millisecond precision over billions of years, I’m curious.)
Example
use chrono::{Utc, TimeZone, NaiveDate};
let dt = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap().and_hms_milli_opt(0, 0, 1, 444).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.timestamp_millis(), 1_444);
let dt = NaiveDate::from_ymd_opt(2001, 9, 9).unwrap().and_hms_milli_opt(1, 46, 40, 555).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.timestamp_millis(), 1_000_000_000_555);
sourcepub fn timestamp_micros(&self) -> i64
pub fn timestamp_micros(&self) -> i64
Returns the number of non-leap-microseconds since January 1, 1970 UTC
Note that this does reduce the number of years that can be represented from ~584 Billion to ~584 Thousand. (If this is a problem, please file an issue to let me know what domain needs microsecond precision over millennia, I’m curious.)
Example
use chrono::{Utc, TimeZone, NaiveDate};
let dt = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap().and_hms_micro_opt(0, 0, 1, 444).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.timestamp_micros(), 1_000_444);
let dt = NaiveDate::from_ymd_opt(2001, 9, 9).unwrap().and_hms_micro_opt(1, 46, 40, 555).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.timestamp_micros(), 1_000_000_000_000_555);
sourcepub fn timestamp_nanos(&self) -> i64
pub fn timestamp_nanos(&self) -> i64
Returns the number of non-leap-nanoseconds since January 1, 1970 UTC
Note that this does reduce the number of years that can be represented from ~584 Billion to ~584. (If this is a problem, please file an issue to let me know what domain needs nanosecond precision over millennia, I’m curious.)
Example
use chrono::{Utc, TimeZone, NaiveDate};
let dt = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap().and_hms_nano_opt(0, 0, 1, 444).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.timestamp_nanos(), 1_000_000_444);
let dt = NaiveDate::from_ymd_opt(2001, 9, 9).unwrap().and_hms_nano_opt(1, 46, 40, 555).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.timestamp_nanos(), 1_000_000_000_000_000_555);
sourcepub fn timestamp_subsec_millis(&self) -> u32
pub fn timestamp_subsec_millis(&self) -> u32
Returns the number of milliseconds since the last second boundary
warning: in event of a leap second, this may exceed 999
note: this is not the number of milliseconds since January 1, 1970 0:00:00 UTC
sourcepub fn timestamp_subsec_micros(&self) -> u32
pub fn timestamp_subsec_micros(&self) -> u32
Returns the number of microseconds since the last second boundary
warning: in event of a leap second, this may exceed 999_999
note: this is not the number of microseconds since January 1, 1970 0:00:00 UTC
sourcepub fn timestamp_subsec_nanos(&self) -> u32
pub fn timestamp_subsec_nanos(&self) -> u32
Returns the number of nanoseconds since the last second boundary
warning: in event of a leap second, this may exceed 999_999_999
note: this is not the number of nanoseconds since January 1, 1970 0:00:00 UTC
sourcepub fn with_timezone<Tz2: TimeZone>(&self, tz: &Tz2) -> DateTime<Tz2>
pub fn with_timezone<Tz2: TimeZone>(&self, tz: &Tz2) -> DateTime<Tz2>
Changes the associated time zone.
The returned DateTime
references the same instant of time from the perspective of the provided time zone.
sourcepub fn checked_add_signed(self, rhs: OldDuration) -> Option<DateTime<Tz>>
pub fn checked_add_signed(self, rhs: OldDuration) -> Option<DateTime<Tz>>
Adds given Duration
to the current date and time.
Returns None
when it will result in overflow.
sourcepub fn checked_add_months(self, rhs: Months) -> Option<DateTime<Tz>>
pub fn checked_add_months(self, rhs: Months) -> Option<DateTime<Tz>>
Adds given Months
to the current date and time.
Returns None
when it will result in overflow, or if the
local time is not valid on the newly calculated date.
See NaiveDate::checked_add_months
for more details on behavior
sourcepub fn checked_sub_signed(self, rhs: OldDuration) -> Option<DateTime<Tz>>
pub fn checked_sub_signed(self, rhs: OldDuration) -> Option<DateTime<Tz>>
Subtracts given Duration
from the current date and time.
Returns None
when it will result in overflow.
sourcepub fn checked_sub_months(self, rhs: Months) -> Option<DateTime<Tz>>
pub fn checked_sub_months(self, rhs: Months) -> Option<DateTime<Tz>>
Subtracts given Months
from the current date and time.
Returns None
when it will result in overflow, or if the
local time is not valid on the newly calculated date.
See NaiveDate::checked_sub_months
for more details on behavior
sourcepub fn checked_add_days(self, days: Days) -> Option<Self>
pub fn checked_add_days(self, days: Days) -> Option<Self>
Add a duration in Days
to the date part of the DateTime
Returns None
if the resulting date would be out of range.
sourcepub fn checked_sub_days(self, days: Days) -> Option<Self>
pub fn checked_sub_days(self, days: Days) -> Option<Self>
Subtract a duration in Days
from the date part of the DateTime
Returns None
if the resulting date would be out of range.
sourcepub fn signed_duration_since<Tz2: TimeZone>(
self,
rhs: DateTime<Tz2>
) -> OldDuration
pub fn signed_duration_since<Tz2: TimeZone>( self, rhs: DateTime<Tz2> ) -> OldDuration
Subtracts another DateTime
from the current date and time.
This does not overflow or underflow at all.
sourcepub fn naive_utc(&self) -> NaiveDateTime
pub fn naive_utc(&self) -> NaiveDateTime
Returns a view to the naive UTC datetime.
sourcepub fn naive_local(&self) -> NaiveDateTime
pub fn naive_local(&self) -> NaiveDateTime
Returns a view to the naive local datetime.
sourcepub fn years_since(&self, base: Self) -> Option<u32>
pub fn years_since(&self, base: Self) -> Option<u32>
Retrieve the elapsed years from now to the given DateTime
.
source§impl DateTime<FixedOffset>
impl DateTime<FixedOffset>
sourcepub fn parse_from_rfc2822(s: &str) -> ParseResult<DateTime<FixedOffset>>
pub fn parse_from_rfc2822(s: &str) -> ParseResult<DateTime<FixedOffset>>
Parses an RFC 2822 date and time string such as Tue, 1 Jul 2003 10:52:37 +0200
,
then returns a new DateTime
with a parsed FixedOffset
.
RFC 2822 is the internet message standard that specifies the representation of times in HTTP and email headers.
assert_eq!(
DateTime::parse_from_rfc2822("Wed, 18 Feb 2015 23:16:09 GMT").unwrap(),
FixedOffset::east_opt(0).unwrap().with_ymd_and_hms(2015, 2, 18, 23, 16, 9).unwrap()
);
sourcepub fn parse_from_rfc3339(s: &str) -> ParseResult<DateTime<FixedOffset>>
pub fn parse_from_rfc3339(s: &str) -> ParseResult<DateTime<FixedOffset>>
Parses an RFC 3339 and ISO 8601 date and time string such as 1996-12-19T16:39:57-08:00
,
then returns a new DateTime
with a parsed FixedOffset
.
Why isn’t this named parse_from_iso8601
? That’s because ISO 8601 allows some freedom
over the syntax and RFC 3339 exercises that freedom to rigidly define a fixed format.
sourcepub fn parse_from_str(s: &str, fmt: &str) -> ParseResult<DateTime<FixedOffset>>
pub fn parse_from_str(s: &str, fmt: &str) -> ParseResult<DateTime<FixedOffset>>
Parses a string with the specified format string and returns a new
DateTime
with a parsed FixedOffset
.
See the crate::format::strftime
module on the supported escape
sequences.
See also TimeZone::datetime_from_str
which gives a local
DateTime
on specific time zone.
Note that this method requires a timezone in the string. See
NaiveDateTime::parse_from_str
for a version that does not require a timezone in the to-be-parsed str.
Example
use chrono::{DateTime, FixedOffset, TimeZone, NaiveDate};
let dt = DateTime::parse_from_str(
"1983 Apr 13 12:09:14.274 +0000", "%Y %b %d %H:%M:%S%.3f %z");
assert_eq!(dt, Ok(FixedOffset::east_opt(0).unwrap().from_local_datetime(&NaiveDate::from_ymd_opt(1983, 4, 13).unwrap().and_hms_milli_opt(12, 9, 14, 274).unwrap()).unwrap()));
source§impl<Tz: TimeZone> DateTime<Tz>where
Tz::Offset: Display,
impl<Tz: TimeZone> DateTime<Tz>where Tz::Offset: Display,
sourcepub fn to_rfc2822(&self) -> String
pub fn to_rfc2822(&self) -> String
Returns an RFC 2822 date and time string such as Tue, 1 Jul 2003 10:52:37 +0200
.
sourcepub fn to_rfc3339(&self) -> String
pub fn to_rfc3339(&self) -> String
Returns an RFC 3339 and ISO 8601 date and time string such as 1996-12-19T16:39:57-08:00
.
sourcepub fn to_rfc3339_opts(&self, secform: SecondsFormat, use_z: bool) -> String
pub fn to_rfc3339_opts(&self, secform: SecondsFormat, use_z: bool) -> String
Return an RFC 3339 and ISO 8601 date and time string with subseconds
formatted as per a SecondsFormat
.
If passed use_z
true and the timezone is UTC (offset 0), use ‘Z’, as
per Fixed::TimezoneOffsetColonZ
If passed use_z
false, use
Fixed::TimezoneOffsetColon
Examples
let dt = NaiveDate::from_ymd_opt(2018, 1, 26).unwrap().and_hms_micro_opt(18, 30, 9, 453_829).unwrap().and_local_timezone(Utc).unwrap();
assert_eq!(dt.to_rfc3339_opts(SecondsFormat::Millis, false),
"2018-01-26T18:30:09.453+00:00");
assert_eq!(dt.to_rfc3339_opts(SecondsFormat::Millis, true),
"2018-01-26T18:30:09.453Z");
assert_eq!(dt.to_rfc3339_opts(SecondsFormat::Secs, true),
"2018-01-26T18:30:09Z");
let pst = FixedOffset::east_opt(8 * 60 * 60).unwrap();
let dt = pst.from_local_datetime(&NaiveDate::from_ymd_opt(2018, 1, 26).unwrap().and_hms_micro_opt(10, 30, 9, 453_829).unwrap()).unwrap();
assert_eq!(dt.to_rfc3339_opts(SecondsFormat::Secs, true),
"2018-01-26T10:30:09+08:00");
sourcepub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I>where
I: Iterator<Item = B> + Clone,
B: Borrow<Item<'a>>,
pub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I>where I: Iterator<Item = B> + Clone, B: Borrow<Item<'a>>,
Formats the combined date and time with the specified formatting items.
sourcepub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>>
pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>>
Formats the combined date and time with the specified format string.
See the crate::format::strftime
module
on the supported escape sequences.
Example
use chrono::prelude::*;
let date_time: DateTime<Utc> = Utc.with_ymd_and_hms(2017, 04, 02, 12, 50, 32).unwrap();
let formatted = format!("{}", date_time.format("%d/%m/%Y %H:%M"));
assert_eq!(formatted, "02/04/2017 12:50");
Trait Implementations§
source§impl<Tz: TimeZone> AddAssign<Duration> for DateTime<Tz>
impl<Tz: TimeZone> AddAssign<Duration> for DateTime<Tz>
source§fn add_assign(&mut self, rhs: OldDuration)
fn add_assign(&mut self, rhs: OldDuration)
+=
operation. Read moresource§impl<Tz: TimeZone> Datelike for DateTime<Tz>
impl<Tz: TimeZone> Datelike for DateTime<Tz>
source§fn year(&self) -> i32
fn year(&self) -> i32
source§fn with_year(&self, year: i32) -> Option<DateTime<Tz>>
fn with_year(&self, year: i32) -> Option<DateTime<Tz>>
source§fn with_month(&self, month: u32) -> Option<DateTime<Tz>>
fn with_month(&self, month: u32) -> Option<DateTime<Tz>>
source§fn with_month0(&self, month0: u32) -> Option<DateTime<Tz>>
fn with_month0(&self, month0: u32) -> Option<DateTime<Tz>>
source§fn with_day(&self, day: u32) -> Option<DateTime<Tz>>
fn with_day(&self, day: u32) -> Option<DateTime<Tz>>
source§fn with_day0(&self, day0: u32) -> Option<DateTime<Tz>>
fn with_day0(&self, day0: u32) -> Option<DateTime<Tz>>
source§fn with_ordinal(&self, ordinal: u32) -> Option<DateTime<Tz>>
fn with_ordinal(&self, ordinal: u32) -> Option<DateTime<Tz>>
source§fn with_ordinal0(&self, ordinal0: u32) -> Option<DateTime<Tz>>
fn with_ordinal0(&self, ordinal0: u32) -> Option<DateTime<Tz>>
source§fn year_ce(&self) -> (bool, u32)
fn year_ce(&self) -> (bool, u32)
source§fn num_days_from_ce(&self) -> i32
fn num_days_from_ce(&self) -> i32
source§impl Default for DateTime<FixedOffset>
impl Default for DateTime<FixedOffset>
source§impl<Tz: TimeZone> DurationRound for DateTime<Tz>
impl<Tz: TimeZone> DurationRound for DateTime<Tz>
§type Err = RoundingError
type Err = RoundingError
source§impl From<DateTime<FixedOffset>> for DateTime<Local>
impl From<DateTime<FixedOffset>> for DateTime<Local>
Convert a DateTime<FixedOffset>
instance into a DateTime<Local>
instance.
source§fn from(src: DateTime<FixedOffset>) -> Self
fn from(src: DateTime<FixedOffset>) -> Self
Convert this DateTime<FixedOffset>
instance into a DateTime<Local>
instance.
Conversion is performed via DateTime::with_timezone
. Returns the equivalent value in local
time.
source§impl From<DateTime<FixedOffset>> for DateTime<Utc>
impl From<DateTime<FixedOffset>> for DateTime<Utc>
Convert a DateTime<FixedOffset>
instance into a DateTime<Utc>
instance.
source§fn from(src: DateTime<FixedOffset>) -> Self
fn from(src: DateTime<FixedOffset>) -> Self
Convert this DateTime<FixedOffset>
instance into a DateTime<Utc>
instance.
Conversion is performed via DateTime::with_timezone
, accounting for the timezone
difference.
source§impl From<DateTime<Local>> for DateTime<FixedOffset>
impl From<DateTime<Local>> for DateTime<FixedOffset>
Convert a DateTime<Local>
instance into a DateTime<FixedOffset>
instance.
source§impl From<DateTime<Local>> for DateTime<Utc>
impl From<DateTime<Local>> for DateTime<Utc>
Convert a DateTime<Local>
instance into a DateTime<Utc>
instance.
source§impl<Tz: TimeZone> From<DateTime<Tz>> for SystemTime
impl<Tz: TimeZone> From<DateTime<Tz>> for SystemTime
source§fn from(dt: DateTime<Tz>) -> SystemTime
fn from(dt: DateTime<Tz>) -> SystemTime
source§impl From<DateTime<Utc>> for DateTime<FixedOffset>
impl From<DateTime<Utc>> for DateTime<FixedOffset>
Convert a DateTime<Utc>
instance into a DateTime<FixedOffset>
instance.
source§impl From<DateTime<Utc>> for DateTime<Local>
impl From<DateTime<Utc>> for DateTime<Local>
Convert a DateTime<Utc>
instance into a DateTime<Local>
instance.
source§impl FromStr for DateTime<FixedOffset>
impl FromStr for DateTime<FixedOffset>
Accepts a relaxed form of RFC3339. A space or a ‘T’ are acepted as the separator between the date and time parts. Additional spaces are allowed between each component.
All of these examples are equivalent:
"2012-12-12T12:12:12Z".parse::<DateTime<FixedOffset>>();
"2012-12-12 12:12:12Z".parse::<DateTime<FixedOffset>>();
"2012- 12-12T12: 12:12Z".parse::<DateTime<FixedOffset>>();
§type Err = ParseError
type Err = ParseError
source§fn from_str(s: &str) -> ParseResult<DateTime<FixedOffset>>
fn from_str(s: &str) -> ParseResult<DateTime<FixedOffset>>
s
to return a value of this type. Read moresource§impl FromStr for DateTime<Local>
impl FromStr for DateTime<Local>
Accepts a relaxed form of RFC3339. A space or a ‘T’ are acepted as the separator between the date and time parts. Additional spaces are allowed between each component.
All of these examples are equivalent:
"2012-12-12T12:12:12Z".parse::<DateTime<Local>>();
"2012-12-12 12:12:12Z".parse::<DateTime<Local>>();
"2012- 12-12T12: 12:12Z".parse::<DateTime<Local>>();
source§impl FromStr for DateTime<Utc>
impl FromStr for DateTime<Utc>
Accepts a relaxed form of RFC3339. A space or a ‘T’ are acepted as the separator between the date and time parts. Additional spaces are allowed between each component.
All of these examples are equivalent:
"2012-12-12T12:12:12Z".parse::<DateTime<Utc>>();
"2012-12-12 12:12:12Z".parse::<DateTime<Utc>>();
"2012- 12-12T12: 12:12Z".parse::<DateTime<Utc>>();
source§impl<Tz: TimeZone> Ord for DateTime<Tz>
impl<Tz: TimeZone> Ord for DateTime<Tz>
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl<Tz: TimeZone, Tz2: TimeZone> PartialEq<DateTime<Tz2>> for DateTime<Tz>
impl<Tz: TimeZone, Tz2: TimeZone> PartialEq<DateTime<Tz2>> for DateTime<Tz>
source§impl<Tz: TimeZone, Tz2: TimeZone> PartialOrd<DateTime<Tz2>> for DateTime<Tz>
impl<Tz: TimeZone, Tz2: TimeZone> PartialOrd<DateTime<Tz2>> for DateTime<Tz>
source§fn partial_cmp(&self, other: &DateTime<Tz2>) -> Option<Ordering>
fn partial_cmp(&self, other: &DateTime<Tz2>) -> Option<Ordering>
Compare two DateTimes based on their true time, ignoring time zones
Example
use chrono::prelude::*;
let earlier = Utc.with_ymd_and_hms(2015, 5, 15, 2, 0, 0).unwrap().with_timezone(&FixedOffset::west_opt(1 * 3600).unwrap());
let later = Utc.with_ymd_and_hms(2015, 5, 15, 3, 0, 0).unwrap().with_timezone(&FixedOffset::west_opt(5 * 3600).unwrap());
assert_eq!(earlier.to_string(), "2015-05-15 01:00:00 -01:00");
assert_eq!(later.to_string(), "2015-05-14 22:00:00 -05:00");
assert!(later > earlier);
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<Tz: TimeZone> SubAssign<Duration> for DateTime<Tz>
impl<Tz: TimeZone> SubAssign<Duration> for DateTime<Tz>
source§fn sub_assign(&mut self, rhs: OldDuration)
fn sub_assign(&mut self, rhs: OldDuration)
-=
operation. Read more