Struct time::OffsetDateTime

pub struct OffsetDateTime { /* fields omitted */ }

A PrimitiveDateTime with a UtcOffset.

All comparisons are performed using the UTC time.

Implementations

impl OffsetDateTime

pub const UNIX_EPOCH: Self

Midnight, 1 January, 1970 (UTC).

assert_eq!(OffsetDateTime::UNIX_EPOCH, datetime!("1970-01-01 0:00 UTC"),);

pub fn now_utc() -> Self

This is supported on crate feature std only.

Create a new OffsetDateTime with the current date and time in UTC.

assert!(OffsetDateTime::now_utc().year() >= 2019);
assert_eq!(OffsetDateTime::now_utc().offset(), offset!("UTC"));

pub fn now_local() -> Result<Self, IndeterminateOffset>

This is supported on crate feature local-offset only.

Attempt to create a new OffsetDateTime with the current date and time in the local offset. If the offset cannot be determined, an error is returned.

assert!(OffsetDateTime::now_local().is_ok());

Due to a soundness bug, the error value is currently always returned on Unix-like platforms.

pub const fn to_offset(self, offset: UtcOffset) -> Self

Convert the OffsetDateTime from the current UtcOffset to the provided UtcOffset.

assert_eq!(
    datetime!("2000-01-01 0:00 UTC")
        .to_offset(offset!("-1"))
        .year(),
    1999,
);

// Let's see what time Sydney's new year's celebration is in New York // and Los Angeles.

// Construct midnight on new year's in Sydney.
let sydney = datetime!("2000-01-01 0:00 +11");
let new_york = sydney.to_offset(offset!("-5"));
let los_angeles = sydney.to_offset(offset!("-8"));
assert_eq!(sydney.hour(), 0);
assert_eq!(new_york.hour(), 8);
assert_eq!(los_angeles.hour(), 5);

pub const fn from_unix_timestamp(timestamp: i64) -> Result<Self, ComponentRange>

Create an OffsetDateTime from the provided Unix timestamp. Calling .offset() on the resulting value is guaranteed to return UTC.

assert_eq!(
    OffsetDateTime::from_unix_timestamp(0),
    Ok(OffsetDateTime::UNIX_EPOCH),
);
assert_eq!(
    OffsetDateTime::from_unix_timestamp(1_546_300_800),
    Ok(datetime!("2019-01-01 0:00 UTC")),
);

If you have a timestamp-nanosecond pair, you can use something along the lines of the following:

let (timestamp, nanos) = (1, 500_000_000);
assert_eq!(
    OffsetDateTime::from_unix_timestamp(timestamp)? + Duration::nanoseconds(nanos),
    OffsetDateTime::UNIX_EPOCH + 1.5.seconds()
);

pub const fn from_unix_timestamp_nanos(
    timestamp: i128
) -> Result<Self, ComponentRange>

Construct an OffsetDateTime from the provided Unix timestamp (in nanoseconds). Calling .offset() on the resulting value is guaranteed to return UTC.

assert_eq!(
    OffsetDateTime::from_unix_timestamp_nanos(0),
    Ok(OffsetDateTime::UNIX_EPOCH),
);
assert_eq!(
    OffsetDateTime::from_unix_timestamp_nanos(1_546_300_800_000_000_000),
    Ok(datetime!("2019-01-01 0:00 UTC")),
);

pub const fn offset(self) -> UtcOffset

Get the UtcOffset.

assert_eq!(datetime!("2019-01-01 0:00 UTC").offset(), offset!("UTC"));
assert_eq!(datetime!("2019-01-01 0:00 +1").offset(), offset!("+1"));

pub const fn unix_timestamp(self) -> i64

Get the Unix timestamp.

assert_eq!(datetime!("1970-01-01 0:00 UTC").unix_timestamp(), 0);
assert_eq!(datetime!("1970-01-01 0:00 -1").unix_timestamp(), 3_600);

pub const fn unix_timestamp_nanos(self) -> i128

Get the Unix timestamp in nanoseconds.

use time::macros::datetime;
assert_eq!(datetime!("1970-01-01 0:00 UTC").unix_timestamp_nanos(), 0);
assert_eq!(
    datetime!("1970-01-01 0:00 -1").unix_timestamp_nanos(),
    3_600_000_000_000,
);

pub const fn date(self) -> Date

Get the Date in the stored offset.

assert_eq!(datetime!("2019-01-01 0:00 UTC").date(), date!("2019-01-01"));
assert_eq!(
    datetime!("2019-01-01 0:00 UTC")
        .to_offset(offset!("-1"))
        .date(),
    date!("2018-12-31"),
);

pub const fn time(self) -> Time

Get the Time in the stored offset.

assert_eq!(datetime!("2019-01-01 0:00 UTC").time(), time!("0:00"));
assert_eq!(
    datetime!("2019-01-01 0:00 UTC")
        .to_offset(offset!("-1"))
        .time(),
    time!("23:00")
);

pub const fn year(self) -> i32

Get the year of the date in the stored offset.

assert_eq!(datetime!("2019-01-01 0:00 UTC").year(), 2019);
assert_eq!(
    datetime!("2019-12-31 23:00 UTC")
        .to_offset(offset!("+1"))
        .year(),
    2020,
);
assert_eq!(datetime!("2020-01-01 0:00 UTC").year(), 2020);

pub const fn month(self) -> u8

Get the month of the date in the stored offset.

The returned value will always be in the range 1..=12.

assert_eq!(datetime!("2019-01-01 0:00 UTC").month(), 1);
assert_eq!(
    datetime!("2019-12-31 23:00 UTC")
        .to_offset(offset!("+1"))
        .month(),
    1,
);

pub const fn day(self) -> u8

Get the day of the date in the stored offset.

The returned value will always be in the range 1..=31.

assert_eq!(datetime!("2019-01-01 0:00 UTC").day(), 1);
assert_eq!(
    datetime!("2019-12-31 23:00 UTC")
        .to_offset(offset!("+1"))
        .day(),
    1,
);

pub const fn ordinal(self) -> u16

Get the day of the year of the date in the stored offset.

The returned value will always be in the range 1..=366.

assert_eq!(datetime!("2019-01-01 0:00 UTC").ordinal(), 1);
assert_eq!(
    datetime!("2019-12-31 23:00 UTC")
        .to_offset(offset!("+1"))
        .ordinal(),
    1,
);

pub const fn iso_week(self) -> u8

Get the ISO week number of the date in the stored offset.

The returned value will always be in the range 1..=53.

assert_eq!(datetime!("2019-01-01 0:00 UTC").iso_week(), 1);
assert_eq!(datetime!("2020-01-01 0:00 UTC").iso_week(), 1);
assert_eq!(datetime!("2020-12-31 0:00 UTC").iso_week(), 53);
assert_eq!(datetime!("2021-01-01 0:00 UTC").iso_week(), 53);

pub const fn sunday_based_week(self) -> u8

Get the week number where week 1 begins on the first Sunday.

The returned value will always be in the range 0..=53.

assert_eq!(datetime!("2019-01-01 0:00 UTC").sunday_based_week(), 0);
assert_eq!(datetime!("2020-01-01 0:00 UTC").sunday_based_week(), 0);
assert_eq!(datetime!("2020-12-31 0:00 UTC").sunday_based_week(), 52);
assert_eq!(datetime!("2021-01-01 0:00 UTC").sunday_based_week(), 0);

pub const fn monday_based_week(self) -> u8

Get the week number where week 1 begins on the first Monday.

The returned value will always be in the range 0..=53.

assert_eq!(datetime!("2019-01-01 0:00 UTC").monday_based_week(), 0);
assert_eq!(datetime!("2020-01-01 0:00 UTC").monday_based_week(), 0);
assert_eq!(datetime!("2020-12-31 0:00 UTC").monday_based_week(), 52);
assert_eq!(datetime!("2021-01-01 0:00 UTC").monday_based_week(), 0);

pub const fn to_calendar_date(self) -> (i32, u8, u8)

Get the year, month, and day.

assert_eq!(
    datetime!("2019-01-01 0:00 UTC").to_calendar_date(),
    (2019, 1, 1)
);

pub const fn to_ordinal_date(self) -> (i32, u16)

Get the year and ordinal day number.

assert_eq!(
    datetime!("2019-01-01 0:00 UTC").to_ordinal_date(),
    (2019, 1)
);

pub const fn to_iso_week_date(self) -> (i32, u8, Weekday)

Get the ISO 8601 year, week number, and weekday.

assert_eq!(
    datetime!("2019-01-01 0:00 UTC").to_iso_week_date(),
    (2019, 1, Tuesday)
);
assert_eq!(
    datetime!("2019-10-04 0:00 UTC").to_iso_week_date(),
    (2019, 40, Friday)
);
assert_eq!(
    datetime!("2020-01-01 0:00 UTC").to_iso_week_date(),
    (2020, 1, Wednesday)
);
assert_eq!(
    datetime!("2020-12-31 0:00 UTC").to_iso_week_date(),
    (2020, 53, Thursday)
);
assert_eq!(
    datetime!("2021-01-01 0:00 UTC").to_iso_week_date(),
    (2020, 53, Friday)
);

pub const fn weekday(self) -> Weekday

Get the weekday of the date in the stored offset.

assert_eq!(datetime!("2019-01-01 0:00 UTC").weekday(), Tuesday);
assert_eq!(datetime!("2019-02-01 0:00 UTC").weekday(), Friday);
assert_eq!(datetime!("2019-03-01 0:00 UTC").weekday(), Friday);

pub const fn to_julian_day(self) -> i32

Get the Julian day for the date. The time is not taken into account for this calculation.

The algorithm to perform this conversion is derived from one provided by Peter Baum; it is freely available here.

assert_eq!(datetime!("-4713-11-24 0:00 UTC").to_julian_day(), 0);
assert_eq!(datetime!("2000-01-01 0:00 UTC").to_julian_day(), 2_451_545);
assert_eq!(datetime!("2019-01-01 0:00 UTC").to_julian_day(), 2_458_485);
assert_eq!(datetime!("2019-12-31 0:00 UTC").to_julian_day(), 2_458_849);

pub const fn to_hms(self) -> (u8, u8, u8)

Get the clock hour, minute, and second.

assert_eq!(datetime!("2020-01-01 0:00:00 UTC").to_hms(), (0, 0, 0));
assert_eq!(datetime!("2020-01-01 23:59:59 UTC").to_hms(), (23, 59, 59));

pub const fn to_hms_milli(self) -> (u8, u8, u8, u16)

Get the clock hour, minute, second, and millisecond.

assert_eq!(
    datetime!("2020-01-01 0:00:00 UTC").to_hms_milli(),
    (0, 0, 0, 0)
);
assert_eq!(
    datetime!("2020-01-01 23:59:59.999 UTC").to_hms_milli(),
    (23, 59, 59, 999)
);

pub const fn to_hms_micro(self) -> (u8, u8, u8, u32)

Get the clock hour, minute, second, and microsecond.

assert_eq!(
    datetime!("2020-01-01 0:00:00 UTC").to_hms_micro(),
    (0, 0, 0, 0)
);
assert_eq!(
    datetime!("2020-01-01 23:59:59.999_999 UTC").to_hms_micro(),
    (23, 59, 59, 999_999)
);

pub const fn to_hms_nano(self) -> (u8, u8, u8, u32)

Get the clock hour, minute, second, and nanosecond.

assert_eq!(
    datetime!("2020-01-01 0:00:00 UTC").to_hms_nano(),
    (0, 0, 0, 0)
);
assert_eq!(
    datetime!("2020-01-01 23:59:59.999_999_999 UTC").to_hms_nano(),
    (23, 59, 59, 999_999_999)
);

pub const fn hour(self) -> u8

Get the clock hour in the stored offset.

The returned value will always be in the range 0..24.

assert_eq!(datetime!("2019-01-01 0:00 UTC").hour(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59 UTC")
        .to_offset(offset!("-2"))
        .hour(),
    21,
);

pub const fn minute(self) -> u8

Get the minute within the hour in the stored offset.

The returned value will always be in the range 0..60.

assert_eq!(datetime!("2019-01-01 0:00 UTC").minute(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59 UTC")
        .to_offset(offset!("+0:30"))
        .minute(),
    29,
);

pub const fn second(self) -> u8

Get the second within the minute in the stored offset.

The returned value will always be in the range 0..60.

assert_eq!(datetime!("2019-01-01 0:00 UTC").second(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59 UTC")
        .to_offset(offset!("+0:00:30"))
        .second(),
    29,
);

pub const fn millisecond(self) -> u16

Get the milliseconds within the second in the stored offset.

The returned value will always be in the range 0..1_000.

assert_eq!(datetime!("2019-01-01 0:00 UTC").millisecond(), 0);
assert_eq!(datetime!("2019-01-01 23:59:59.999 UTC").millisecond(), 999);

pub const fn microsecond(self) -> u32

Get the microseconds within the second in the stored offset.

The returned value will always be in the range 0..1_000_000.

assert_eq!(datetime!("2019-01-01 0:00 UTC").microsecond(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59.999_999 UTC").microsecond(),
    999_999,
);

pub const fn nanosecond(self) -> u32

Get the nanoseconds within the second in the stored offset.

The returned value will always be in the range 0..1_000_000_000.

assert_eq!(datetime!("2019-01-01 0:00 UTC").nanosecond(), 0);
assert_eq!(
    datetime!("2019-01-01 23:59:59.999_999_999 UTC").nanosecond(),
    999_999_999,
);

impl OffsetDateTime

Methods that replace part of the OffsetDateTime.

#[must_use = "This method does not mutate the original `OffsetDateTime`."]

pub const fn replace_time(self, time: Time) -> Self

Replace the time, which is assumed to be in the stored offset. The date and offset components are unchanged.

assert_eq!(
    datetime!("2020-01-01 5:00 UTC").replace_time(time!("12:00")),
    datetime!("2020-01-01 12:00 UTC")
);
assert_eq!(
    datetime!("2020-01-01 12:00 -5").replace_time(time!("7:00")),
    datetime!("2020-01-01 7:00 -5")
);
assert_eq!(
    datetime!("2020-01-01 0:00 +1").replace_time(time!("12:00")),
    datetime!("2020-01-01 12:00 +1")
);

#[must_use = "This method does not mutate the original `OffsetDateTime`."]

pub const fn replace_date(self, date: Date) -> Self

Replace the date, which is assumed to be in the stored offset. The time and offset components are unchanged.

assert_eq!(
    datetime!("2020-01-01 12:00 UTC").replace_date(date!("2020-01-30")),
    datetime!("2020-01-30 12:00 UTC")
);
assert_eq!(
    datetime!("2020-01-01 0:00 +1").replace_date(date!("2020-01-30")),
    datetime!("2020-01-30 0:00 +1")
);

#[must_use = "This method does not mutate the original `OffsetDateTime`."]

pub const fn replace_date_time(self, date_time: PrimitiveDateTime) -> Self

Replace the date and time, which are assumed to be in the stored offset. The offset component remains unchanged.

assert_eq!(
    datetime!("2020-01-01 12:00 UTC").replace_date_time(datetime!("2020-01-30 16:00")),
    datetime!("2020-01-30 16:00 UTC")
);
assert_eq!(
    datetime!("2020-01-01 12:00 +1").replace_date_time(datetime!("2020-01-30 0:00")),
    datetime!("2020-01-30 0:00 +1")
);

#[must_use = "This method does not mutate the original `OffsetDateTime`."]

pub const fn replace_offset(self, offset: UtcOffset) -> Self

Replace the offset. The date and time components remain unchanged.

assert_eq!(
    datetime!("2020-01-01 0:00 UTC").replace_offset(offset!("-5")),
    datetime!("2020-01-01 0:00 -5")
);

impl OffsetDateTime

pub fn format_into(
    self,
    output: &mut impl Write,
    format: &impl Formattable
) -> Result<usize, Format>

This is supported on crate feature formatting only.

Format the OffsetDateTime using the provided format description. The formatted value will be output to the provided writer. The format description will typically be parsed by using format_description::parse.

pub fn format(self, format: &impl Formattable) -> Result<String, Format>

This is supported on crate feature formatting only.

Format the OffsetDateTime using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse(
    "[year]-[month]-[day] [hour]:[minute]:[second] [offset_hour \
         sign:mandatory]:[offset_minute]:[offset_second]",
)?;
assert_eq!(
    datetime!("2020-01-02 03:04:05 +06:07:08").format(&format)?,
    "2020-01-02 03:04:05 +06:07:08"
);

impl OffsetDateTime

pub fn parse(input: &str, description: &impl Parsable) -> Result<Self, Parse>

This is supported on crate feature parsing only.

Parse a PrimitiveDateTime from the input using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse(
    "[year]-[month]-[day] [hour]:[minute]:[second] [offset_hour \
         sign:mandatory]:[offset_minute]:[offset_second]",
)?;
assert_eq!(
    OffsetDateTime::parse("2020-01-02 03:04:05 +06:07:08", &format)?,
    datetime!("2020-01-02 03:04:05 +06:07:08")
);

Trait Implementations

impl<T> Add<T> for OffsetDateTime where
    PrimitiveDateTime: Add<T, Output = PrimitiveDateTime>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T> AddAssign<T> for OffsetDateTime where
    Self: Add<T, Output = Self>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Arbitrary for OffsetDateTime

This is supported on crate feature quickcheck only.

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl Clone for OffsetDateTime

fn clone(&self) -> OffsetDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OffsetDateTime

impl Debug for OffsetDateTime

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for OffsetDateTime

This is supported on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for OffsetDateTime

This is supported on crate feature formatting only.

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

Formats the value using the given formatter.

impl Eq for OffsetDateTime

impl From<SystemTime> for OffsetDateTime

This is supported on crate feature std only.

fn from(system_time: SystemTime) -> Self

Performs the conversion.

impl Hash for OffsetDateTime

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

pub 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 OffsetDateTime

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<OffsetDateTime> for OffsetDateTime

fn eq(&self, rhs: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl PartialEq<SystemTime> for OffsetDateTime

This is supported on crate feature std only.

fn eq(&self, rhs: &SystemTime) -> bool

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<OffsetDateTime> for OffsetDateTime

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 PartialOrd<SystemTime> for OffsetDateTime

This is supported on crate feature std only.

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 OffsetDateTime

This is supported on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralEq for OffsetDateTime

impl Sub<OffsetDateTime> for OffsetDateTime

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Sub<SystemTime> for OffsetDateTime

This is supported on crate feature std only.

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: SystemTime) -> Self::Output

Performs the - operation.

impl<T> Sub<T> for OffsetDateTime where
    PrimitiveDateTime: Sub<T, Output = PrimitiveDateTime>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T> SubAssign<T> for OffsetDateTime where
    Self: Sub<T, Output = Self>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<Parsed> for OffsetDateTime

This is supported on crate feature parsing only.

type Error = TryFromParsed

The type returned in the event of a conversion error.

fn try_from(parsed: Parsed) -> Result<Self, Self::Error>

Performs the conversion.