Struct time::PrimitiveDateTime

pub struct PrimitiveDateTime { /* fields omitted */ }

Combined date and time.

Methods

impl PrimitiveDateTime

pub const fn new(date: Date, time: Time) -> Self

Create a new PrimitiveDateTime from the provided Date and Time.

assert_eq!(
    PrimitiveDateTime::new(Date::try_from_ymd(2019, 1, 1).unwrap(), Time::midnight()),
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight(),
);

pub fn now() -> Self

This is supported on feature="std" only.

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

assert!(PrimitiveDateTime::now().year() >= 2019);

pub const fn unix_epoch() -> Self

Midnight, 1 January, 1970 (UTC).

assert_eq!(
    PrimitiveDateTime::unix_epoch(),
    Date::try_from_ymd(1970, 1, 1).unwrap().midnight()
);

pub fn from_unix_timestamp(timestamp: i64) -> Self

Create a PrimitiveDateTime from the provided Unix timestamp.

assert_eq!(
    PrimitiveDateTime::from_unix_timestamp(0),
    PrimitiveDateTime::unix_epoch()
);
assert_eq!(
    PrimitiveDateTime::from_unix_timestamp(1_546_300_800),
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight(),
);

pub fn timestamp(self) -> i64

Get the Unix timestamp representing the PrimitiveDateTime.

assert_eq!(PrimitiveDateTime::unix_epoch().timestamp(), 0);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .timestamp(),
    1_546_300_800
);

pub const fn date(self) -> Date

Get the Date component of the PrimitiveDateTime.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight().date(),
    Date::try_from_ymd(2019, 1, 1).unwrap()
);

pub const fn time(self) -> Time

Get the Time component of the PrimitiveDateTime.

assert_eq!(Date::try_from_ymd(2019, 1, 1).unwrap().midnight().time(), Time::midnight());

pub fn year(self) -> i32

Get the year of the date.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight().year(),
    2019
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31).unwrap().midnight().year(),
    2019
);
assert_eq!(
    Date::try_from_ymd(2020, 1, 1).unwrap().midnight().year(),
    2020
);

pub fn month(self) -> u8

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

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

assert_eq!(
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight().month(),
    1
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31).unwrap().midnight().month(),
    12
);

pub fn day(self) -> u8

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

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

assert_eq!(Date::try_from_ymd(2019, 1, 1).unwrap().midnight().day(), 1);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31).unwrap().midnight().day(),
    31
);

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

Get the month and day of the date. This is more efficient than fetching the components individually.

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()
        .month_day(),
    (1, 1)
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .midnight()
        .month_day(),
    (12, 31)
);

pub fn ordinal(self) -> u16

Get the day of the year.

The returned value will always be in the range 1..=366 (1..=365 for common years).

assert_eq!(
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight().ordinal(),
    1
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 31)
        .unwrap()
        .midnight()
        .ordinal(),
    365
);

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

Get the ISO 8601 year and week number.

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

pub fn week(self) -> u8

Get the ISO week number.

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

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

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .sunday_based_week(),
    0
);
assert_eq!(
    Date::try_from_ymd(2020, 1, 1)
        .unwrap()
        .midnight()
        .sunday_based_week(),
    0
);
assert_eq!(
    Date::try_from_ymd(2020, 12, 31)
        .unwrap()
        .midnight()
        .sunday_based_week(),
    52
);
assert_eq!(
    Date::try_from_ymd(2021, 1, 1)
        .unwrap()
        .midnight()
        .sunday_based_week(),
    0
);

pub 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!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .monday_based_week(),
    0
);
assert_eq!(
    Date::try_from_ymd(2020, 1, 1)
        .unwrap()
        .midnight()
        .monday_based_week(),
    0
);
assert_eq!(
    Date::try_from_ymd(2020, 12, 31)
        .unwrap()
        .midnight()
        .monday_based_week(),
    52
);
assert_eq!(
    Date::try_from_ymd(2021, 1, 1)
        .unwrap()
        .midnight()
        .monday_based_week(),
    0
);

pub fn weekday(self) -> Weekday

Get the weekday.

This current uses Zeller's congruence internally.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1).unwrap().midnight().weekday(),
    Tuesday
);
assert_eq!(
    Date::try_from_ymd(2019, 2, 1).unwrap().midnight().weekday(),
    Friday
);
assert_eq!(
    Date::try_from_ymd(2019, 3, 1).unwrap().midnight().weekday(),
    Friday
);
assert_eq!(
    Date::try_from_ymd(2019, 4, 1).unwrap().midnight().weekday(),
    Monday
);
assert_eq!(
    Date::try_from_ymd(2019, 5, 1).unwrap().midnight().weekday(),
    Wednesday
);
assert_eq!(
    Date::try_from_ymd(2019, 6, 1).unwrap().midnight().weekday(),
    Saturday
);
assert_eq!(
    Date::try_from_ymd(2019, 7, 1).unwrap().midnight().weekday(),
    Monday
);
assert_eq!(
    Date::try_from_ymd(2019, 8, 1).unwrap().midnight().weekday(),
    Thursday
);
assert_eq!(
    Date::try_from_ymd(2019, 9, 1).unwrap().midnight().weekday(),
    Sunday
);
assert_eq!(
    Date::try_from_ymd(2019, 10, 1)
        .unwrap()
        .midnight()
        .weekday(),
    Tuesday
);
assert_eq!(
    Date::try_from_ymd(2019, 11, 1)
        .unwrap()
        .midnight()
        .weekday(),
    Friday
);
assert_eq!(
    Date::try_from_ymd(2019, 12, 1)
        .unwrap()
        .midnight()
        .weekday(),
    Sunday
);

pub const fn hour(self) -> u8

Get the clock hour.

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()
        .hour(),
    0
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap()
        .hour(),
    23
);

pub const fn minute(self) -> u8

Get the minute within the hour.

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()
        .minute(),
    0
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap()
        .minute(),
    59
);

pub const fn second(self) -> u8

Get the second within the minute.

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()
        .second(),
    0
);
assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .try_with_hms(23, 59, 59)
        .unwrap()
        .second(),
    59
);

pub const fn millisecond(self) -> u16

Get the milliseconds within the second.

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

pub const fn microsecond(self) -> u32

Get the microseconds within the second.

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

pub const fn nanosecond(self) -> u32

Get the nanoseconds within the second.

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

pub const fn using_offset(self, offset: UtcOffset) -> OffsetDateTime

Create an OffsetDateTime from the existing PrimitiveDateTime and provided UtcOffset.

assert_eq!(
    Date::try_from_ymd(2019, 1, 1)
        .unwrap()
        .midnight()
        .using_offset(UtcOffset::UTC)
        .timestamp(),
    1_546_300_800,
);

impl PrimitiveDateTime

Methods that allow formatting the PrimitiveDateTime.

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

Format the PrimitiveDateTime using the provided string.

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

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

Attempt to parse a PrimitiveDateTime 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 PrimitiveDateTime

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for PrimitiveDateTime

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Duration> for PrimitiveDateTime

fn add_assign(&mut self, duration: Duration)

Performs the += operation.

impl AddAssign<Duration> for PrimitiveDateTime

fn add_assign(&mut self, duration: StdDuration)

Performs the += operation.

impl Clone for PrimitiveDateTime

fn clone(&self) -> PrimitiveDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PrimitiveDateTime

impl Debug for PrimitiveDateTime

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrimitiveDateTime

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

Deserialize this value from the given Serde deserializer.

impl Eq for PrimitiveDateTime

impl From<PrimitiveDateTime> for SystemTime

fn from(datetime: PrimitiveDateTime) -> Self

Performs the conversion.

impl From<SystemTime> for PrimitiveDateTime

fn from(system_time: SystemTime) -> Self

Performs the conversion.

impl Hash for PrimitiveDateTime

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 PrimitiveDateTime

fn cmp(&self, other: &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<PrimitiveDateTime> for PrimitiveDateTime

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

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

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

This method tests for !=.

impl PartialEq<PrimitiveDateTime> for SystemTime

fn eq(&self, rhs: &PrimitiveDateTime) -> 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 PartialEq<SystemTime> for PrimitiveDateTime

fn eq(&self, rhs: &SystemTime) -> 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<PrimitiveDateTime> for PrimitiveDateTime

fn partial_cmp(&self, other: &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 PartialOrd<PrimitiveDateTime> for SystemTime

fn partial_cmp(&self, other: &PrimitiveDateTime) -> 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 PartialOrd<SystemTime> for PrimitiveDateTime

fn partial_cmp(&self, other: &SystemTime) -> 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 Serialize for PrimitiveDateTime

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

Serialize this value into the given Serde serializer.

impl StructuralEq for PrimitiveDateTime

impl StructuralPartialEq for PrimitiveDateTime

impl Sub<Duration> for PrimitiveDateTime

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for PrimitiveDateTime

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<PrimitiveDateTime> for PrimitiveDateTime

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<PrimitiveDateTime> for SystemTime

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<SystemTime> for PrimitiveDateTime

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Duration> for PrimitiveDateTime

fn sub_assign(&mut self, duration: Duration)

Performs the -= operation.

impl SubAssign<Duration> for PrimitiveDateTime

fn sub_assign(&mut self, duration: StdDuration)

Performs the -= operation.