Struct time::OffsetDateTime

pub struct OffsetDateTime { /* fields omitted */ }

A PrimitiveDateTime with a UtcOffset.

For equality, comparisons, and hashing, calculations are performed using the Unix timestamp.

Methods

impl OffsetDateTime

pub fn now() -> Self

This is supported on feature="std" only.

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

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

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

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

assert_eq!(
    Date::try_from_ymd(2000, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .to_offset(UtcOffset::hours(-1))
        .year(),
    1999,
);

pub const fn unix_epoch() -> Self

Midnight, 1 January, 1970 (UTC).

assert_eq!(
    OffsetDateTime::unix_epoch(),
    Date::try_from_ymd(1970, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC),
);

pub fn from_unix_timestamp(timestamp: i64) -> Self

Create an OffsetDateTime from the provided Unix timestamp.

assert_eq!(
    OffsetDateTime::from_unix_timestamp(0),
    OffsetDateTime::unix_epoch(),
);
assert_eq!(
    OffsetDateTime::from_unix_timestamp(1_546_300_800),
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC),
);

pub const fn offset(self) -> UtcOffset

Get the UtcOffset.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .offset(),
    UtcOffset::UTC,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::hours(1))
        .offset(),
    UtcOffset::hours(1),
);

pub fn timestamp(self) -> i64

Get the Unix timestamp.

assert_eq!(
    PrimitiveDateTime::unix_epoch()
        .using_offset(UtcOffset::UTC)
        .timestamp(),
    0,
);
assert_eq!(
    PrimitiveDateTime::unix_epoch()
        .using_offset(UtcOffset::hours(-1))
        .timestamp(),
    3_600,
);

pub fn date(self) -> Date

Get the Date in the stored offset.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .date(),
    Date::try_from_ymd(2019, 1, 1).unwrap(),
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::hours(-1))
        .date(),
    Date::try_from_ymd(2018, 12, 31).unwrap(),
);

pub fn time(self) -> Time

Get the Time in the stored offset.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .time(),
    Time::try_from_hms(0, 0, 0).unwrap(),
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::hours(-1))
        .time(),
    Time::try_from_hms(23, 0, 0).unwrap(),
);

pub fn year(self) -> i32

Get the year of the date in the stored offset.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .year(),
    2019,
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .try_with_hms(23, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .to_offset(UtcOffset::hours(1))
        .year(),
    2020,
);
assert_eq!(
    Date::try_from_ymd(2020, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .year(),
    2020,
);

pub fn month(self) -> u8

Get the month of the date in the stored offset. If fetching both the month and day, it is more efficient to use OffsetDateTime::month_day.

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

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .month(),
    1,
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .try_with_hms(23, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::hours(1))
        .month(),
    1,
);

pub fn day(self) -> u8

Get the day of the date in the stored offset. If fetching both the month and day, it is more efficient to use OffsetDateTime::month_day.

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

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .day(),
    1,
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .try_with_hms(23, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::hours(1))
        .day(),
    1,
);

pub fn month_day(self) -> (u8, u8)

Get the month and day of the date in the stored offset.

The month component will always be in the range 1..=12; the day component in 1..=31.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .month_day(),
    (1, 1),
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .try_with_hms(23, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::hours(1))
        .month_day(),
    (1, 1),
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .ordinal(),
    1,
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .try_with_hms(23, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::hours(1))
        .ordinal(),
    1,
);

pub fn iso_year_week(self) -> (i32, u8)

Get the ISO 8601 year and week number in the stored offset.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .iso_year_week(),
    (2019, 1),
);
assert_eq!(
    Date::try_from_ymd(2019, 10, 4)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .iso_year_week(),
    (2019, 40),
);
assert_eq!(
    Date::try_from_ymd(2020, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .iso_year_week(),
    (2020, 1),
);
assert_eq!(
    Date::try_from_ymd(2020, 12, 31)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .iso_year_week(),
    (2020, 53),
);
assert_eq!(
    Date::try_from_ymd(2021, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .iso_year_week(),
    (2020, 53),
);

pub fn 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .week(),
    1,
);
assert_eq!(
    Date::try_from_ymd(2020, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .week(),
    1,
);
assert_eq!(
    Date::try_from_ymd(2020, 12, 31)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .week(),
    53,
);
assert_eq!(
    Date::try_from_ymd(2021, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .week(),
    53,
);

pub fn weekday(self) -> Weekday

Get the weekday of the date in the stored offset.

This current uses Zeller's congruence internally.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .weekday(),
    Tuesday,
);
assert_eq!(
    Date::try_from_ymd(2019, 2, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .weekday(),
    Friday,
);
assert_eq!(
    Date::try_from_ymd(2019, 3, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .weekday(),
    Friday,
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .hour(),
    0,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap()
        .using_offset(UtcOffset::hours(-2))
        .hour(),
    21,
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .minute(),
    0,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap()
        .using_offset(UtcOffset::minutes(30))
        .minute(),
    29,
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .second(),
    0,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap()
        .using_offset(UtcOffset::seconds(30))
        .second(),
    29,
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms_milli(0, 0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .millisecond(),
    0,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms_milli(23, 59, 59, 999)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .millisecond(),
    999,
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms_micro(0, 0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .microsecond(),
    0,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms_micro(23, 59, 59, 999_999)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .microsecond(),
    999_999,
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms_nano(0, 0, 0, 0)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .nanosecond(),
    0,
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms_nano(23, 59, 59, 999_999_999)
        .unwrap()
        .using_offset(UtcOffset::UTC)
        .nanosecond(),
    999_999_999,
);

impl OffsetDateTime

Methods that allow formatting the OffsetDateTime.

pub fn format(self, format: &str) -> String

Format the OffsetDateTime using the provided string.

assert_eq!(
    Date::try_from_ymd(2019, 1, 2)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .format("%F %r %z"),
    "2019-01-02 12:00:00 am +0000",
);

pub fn parse(s: &str, format: &str) -> Result<Self, ParseError>

Attempt to parse an OffsetDateTime using the provided string.

assert_eq!(
    PrimitiveDateTime::parse("2019-01-02 00:00:00", "%F %T"),
    Ok(Date::try_from_ymd(2019, 1, 2).unwrap().midnight()),
);
assert_eq!(
    PrimitiveDateTime::parse("2019-002 23:59:59", "%Y-%j %T"),
    Ok(Date::try_from_yo(2019, 2)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap())
);
assert_eq!(
    PrimitiveDateTime::parse("2019-W01-3 12:00:00 pm", "%G-W%V-%u %r"),
    Ok(Date::try_from_iso_ywd(2019, 1, Wednesday)
        .unwrap()
        .try_with_hms(12, 0, 0)
        .unwrap()),
);

Trait Implementations

impl Add<Duration> for OffsetDateTime

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: Duration) -> Self::Output

Performs the + operation.

impl Add<Duration> for OffsetDateTime

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: StdDuration) -> Self::Output

Performs the + operation.

impl AddAssign<Duration> for OffsetDateTime

fn add_assign(&mut self, duration: Duration)

Performs the += operation.

impl AddAssign<Duration> for OffsetDateTime

fn add_assign(&mut self, duration: StdDuration)

Performs the += operation.

impl Clone for OffsetDateTime

fn clone(&self) -> OffsetDateTime

Returns a copy of the value.

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 Eq for OffsetDateTime

impl Hash for OffsetDateTime

fn hash<H: Hasher>(&self, hasher: &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 OffsetDateTime

fn cmp(&self, rhs: &Self) -> 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

🔬 This is a nightly-only experimental API. (clamp)

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] 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] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 StructuralEq for OffsetDateTime

impl Sub<Duration> for OffsetDateTime

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: Duration) -> Self::Output

Performs the - operation.

impl Sub<Duration> for OffsetDateTime

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: StdDuration) -> Self::Output

Performs the - operation.

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 SubAssign<Duration> for OffsetDateTime

fn sub_assign(&mut self, duration: Duration)

Performs the -= operation.

impl SubAssign<Duration> for OffsetDateTime

fn sub_assign(&mut self, duration: StdDuration)

Performs the -= operation.