Skip to main content

UtcDateTime

tower_cookies::cookie::time

Struct UtcDateTime 

Source 
pub struct UtcDateTime { /* private fields */ }
Expand description

A PrimitiveDateTime that is known to be UTC.

UtcDateTime is guaranteed to be ABI-compatible with PrimitiveDateTime, meaning that transmuting from one to the other will not result in undefined behavior.

Implementations§

Source§

impl UtcDateTime

Source

pub const UNIX_EPOCH: UtcDateTime

Midnight, 1 January, 1970.

assert_eq!(UtcDateTime::UNIX_EPOCH, utc_datetime!(1970-01-01 0:00));
Source

pub const MIN: UtcDateTime

The smallest value that can be represented by UtcDateTime.

Depending on large-dates feature flag, value of this constant may vary.

  1. With large-dates disabled it is equal to -9999-01-01 00:00:00.0
  2. With large-dates enabled it is equal to -999999-01-01 00:00:00.0
// Assuming `large-dates` feature is disabled.
assert_eq!(UtcDateTime::MIN, utc_datetime!(-9999-01-01 0:00));
Source

pub const MAX: UtcDateTime

The largest value that can be represented by UtcDateTime.

Depending on large-dates feature flag, value of this constant may vary.

  1. With large-dates disabled it is equal to 9999-12-31 23:59:59.999_999_999
  2. With large-dates enabled it is equal to 999999-12-31 23:59:59.999_999_999
// Assuming `large-dates` feature is disabled.
assert_eq!(UtcDateTime::MAX, utc_datetime!(+9999-12-31 23:59:59.999_999_999));
Source

pub fn now() -> UtcDateTime

Create a new UtcDateTime with the current date and time.

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

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

Create a new UtcDateTime from the provided Date and Time.

assert_eq!(
    UtcDateTime::new(date!(2019-01-01), time!(0:00)),
    utc_datetime!(2019-01-01 0:00),
);
Source

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

Create a UtcDateTime from the provided Unix timestamp.

assert_eq!(
    UtcDateTime::from_unix_timestamp(0),
    Ok(UtcDateTime::UNIX_EPOCH),
);
assert_eq!(
    UtcDateTime::from_unix_timestamp(1_546_300_800),
    Ok(utc_datetime!(2019-01-01 0:00)),
);

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!(
    UtcDateTime::from_unix_timestamp(timestamp)? + Duration::nanoseconds(nanos),
    UtcDateTime::UNIX_EPOCH + 1.5.seconds()
);
Source

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

Construct an UtcDateTime from the provided Unix timestamp (in nanoseconds).

assert_eq!(
    UtcDateTime::from_unix_timestamp_nanos(0),
    Ok(UtcDateTime::UNIX_EPOCH),
);
assert_eq!(
    UtcDateTime::from_unix_timestamp_nanos(1_546_300_800_000_000_000),
    Ok(utc_datetime!(2019-01-01 0:00)),
);
Source

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

Convert the UtcDateTime from UTC to the provided UtcOffset, returning an OffsetDateTime.

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

// Construct midnight on new year's, UTC.
let utc = utc_datetime!(2000-01-01 0:00);
let new_york = utc.to_offset(offset!(-5));
let los_angeles = utc.to_offset(offset!(-8));
assert_eq!(utc.hour(), 0);
assert_eq!(new_york.hour(), 19);
assert_eq!(los_angeles.hour(), 16);
§Panics

This method panics if the local date-time in the new offset is outside the supported range.

Source

pub const fn checked_to_offset( self, offset: UtcOffset, ) -> Option<OffsetDateTime>

Convert the UtcDateTime from UTC to the provided UtcOffset, returning an OffsetDateTime. None is returned if the date-time in the resulting offset is invalid.

assert_eq!(
    utc_datetime!(2000-01-01 0:00)
        .checked_to_offset(offset!(-1))
        .unwrap()
        .year(),
    1999,
);
assert_eq!(
    UtcDateTime::MAX.checked_to_offset(offset!(+1)),
    None,
);
Source

pub const fn unix_timestamp(self) -> i64

Get the Unix timestamp.

assert_eq!(utc_datetime!(1970-01-01 0:00).unix_timestamp(), 0);
assert_eq!(utc_datetime!(1970-01-01 1:00).unix_timestamp(), 3_600);
Source

pub const fn unix_timestamp_nanos(self) -> i128

Get the Unix timestamp in nanoseconds.

use time_macros::utc_datetime;
assert_eq!(utc_datetime!(1970-01-01 0:00).unix_timestamp_nanos(), 0);
assert_eq!(
    utc_datetime!(1970-01-01 1:00).unix_timestamp_nanos(),
    3_600_000_000_000,
);
Source

pub const fn date(self) -> Date

Get the Date component of the UtcDateTime.

assert_eq!(utc_datetime!(2019-01-01 0:00).date(), date!(2019-01-01));
Source

pub const fn time(self) -> Time

Get the Time component of the UtcDateTime.

assert_eq!(utc_datetime!(2019-01-01 0:00).time(), time!(0:00));
Source

pub const fn year(self) -> i32

Get the year of the date.

assert_eq!(utc_datetime!(2019-01-01 0:00).year(), 2019);
assert_eq!(utc_datetime!(2019-12-31 0:00).year(), 2019);
assert_eq!(utc_datetime!(2020-01-01 0:00).year(), 2020);
Source

pub const fn month(self) -> Month

Get the month of the date.

assert_eq!(utc_datetime!(2019-01-01 0:00).month(), Month::January);
assert_eq!(utc_datetime!(2019-12-31 0:00).month(), Month::December);
Source

pub const fn day(self) -> u8

Get the day of the date.

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

assert_eq!(utc_datetime!(2019-01-01 0:00).day(), 1);
assert_eq!(utc_datetime!(2019-12-31 0:00).day(), 31);
Source

pub const 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!(utc_datetime!(2019-01-01 0:00).ordinal(), 1);
assert_eq!(utc_datetime!(2019-12-31 0:00).ordinal(), 365);
Source

pub const fn iso_week(self) -> u8

Get the ISO week number.

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

assert_eq!(utc_datetime!(2019-01-01 0:00).iso_week(), 1);
assert_eq!(utc_datetime!(2019-10-04 0:00).iso_week(), 40);
assert_eq!(utc_datetime!(2020-01-01 0:00).iso_week(), 1);
assert_eq!(utc_datetime!(2020-12-31 0:00).iso_week(), 53);
assert_eq!(utc_datetime!(2021-01-01 0:00).iso_week(), 53);
Source

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!(utc_datetime!(2019-01-01 0:00).sunday_based_week(), 0);
assert_eq!(utc_datetime!(2020-01-01 0:00).sunday_based_week(), 0);
assert_eq!(utc_datetime!(2020-12-31 0:00).sunday_based_week(), 52);
assert_eq!(utc_datetime!(2021-01-01 0:00).sunday_based_week(), 0);
Source

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!(utc_datetime!(2019-01-01 0:00).monday_based_week(), 0);
assert_eq!(utc_datetime!(2020-01-01 0:00).monday_based_week(), 0);
assert_eq!(utc_datetime!(2020-12-31 0:00).monday_based_week(), 52);
assert_eq!(utc_datetime!(2021-01-01 0:00).monday_based_week(), 0);
Source

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

Get the year, month, and day.

assert_eq!(
    utc_datetime!(2019-01-01 0:00).to_calendar_date(),
    (2019, Month::January, 1)
);
Source

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

Get the year and ordinal day number.

assert_eq!(utc_datetime!(2019-01-01 0:00).to_ordinal_date(), (2019, 1));
Source

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

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

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

pub const fn weekday(self) -> Weekday

Get the weekday.

assert_eq!(utc_datetime!(2019-01-01 0:00).weekday(), Tuesday);
assert_eq!(utc_datetime!(2019-02-01 0:00).weekday(), Friday);
assert_eq!(utc_datetime!(2019-03-01 0:00).weekday(), Friday);
assert_eq!(utc_datetime!(2019-04-01 0:00).weekday(), Monday);
assert_eq!(utc_datetime!(2019-05-01 0:00).weekday(), Wednesday);
assert_eq!(utc_datetime!(2019-06-01 0:00).weekday(), Saturday);
assert_eq!(utc_datetime!(2019-07-01 0:00).weekday(), Monday);
assert_eq!(utc_datetime!(2019-08-01 0:00).weekday(), Thursday);
assert_eq!(utc_datetime!(2019-09-01 0:00).weekday(), Sunday);
assert_eq!(utc_datetime!(2019-10-01 0:00).weekday(), Tuesday);
assert_eq!(utc_datetime!(2019-11-01 0:00).weekday(), Friday);
assert_eq!(utc_datetime!(2019-12-01 0:00).weekday(), Sunday);
Source

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.

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

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

Get the clock hour, minute, and second.

assert_eq!(utc_datetime!(2020-01-01 0:00:00).as_hms(), (0, 0, 0));
assert_eq!(utc_datetime!(2020-01-01 23:59:59).as_hms(), (23, 59, 59));
Source

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

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

assert_eq!(utc_datetime!(2020-01-01 0:00:00).as_hms_milli(), (0, 0, 0, 0));
assert_eq!(
    utc_datetime!(2020-01-01 23:59:59.999).as_hms_milli(),
    (23, 59, 59, 999)
);
Source

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

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

assert_eq!(utc_datetime!(2020-01-01 0:00:00).as_hms_micro(), (0, 0, 0, 0));
assert_eq!(
    utc_datetime!(2020-01-01 23:59:59.999_999).as_hms_micro(),
    (23, 59, 59, 999_999)
);
Source

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

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

assert_eq!(utc_datetime!(2020-01-01 0:00:00).as_hms_nano(), (0, 0, 0, 0));
assert_eq!(
    utc_datetime!(2020-01-01 23:59:59.999_999_999).as_hms_nano(),
    (23, 59, 59, 999_999_999)
);
Source

pub const fn hour(self) -> u8

Get the clock hour.

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

assert_eq!(utc_datetime!(2019-01-01 0:00).hour(), 0);
assert_eq!(utc_datetime!(2019-01-01 23:59:59).hour(), 23);
Source

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!(utc_datetime!(2019-01-01 0:00).minute(), 0);
assert_eq!(utc_datetime!(2019-01-01 23:59:59).minute(), 59);
Source

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!(utc_datetime!(2019-01-01 0:00).second(), 0);
assert_eq!(utc_datetime!(2019-01-01 23:59:59).second(), 59);
Source

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!(utc_datetime!(2019-01-01 0:00).millisecond(), 0);
assert_eq!(utc_datetime!(2019-01-01 23:59:59.999).millisecond(), 999);
Source

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!(utc_datetime!(2019-01-01 0:00).microsecond(), 0);
assert_eq!(
    utc_datetime!(2019-01-01 23:59:59.999_999).microsecond(),
    999_999
);
Source

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!(utc_datetime!(2019-01-01 0:00).nanosecond(), 0);
assert_eq!(
    utc_datetime!(2019-01-01 23:59:59.999_999_999).nanosecond(),
    999_999_999,
);
Source

pub const fn checked_add(self, duration: Duration) -> Option<UtcDateTime>

Computes self + duration, returning None if an overflow occurred.

assert_eq!(UtcDateTime::MIN.checked_add((-2).days()), None);
assert_eq!(UtcDateTime::MAX.checked_add(1.days()), None);
assert_eq!(
    utc_datetime!(2019-11-25 15:30).checked_add(27.hours()),
    Some(utc_datetime!(2019-11-26 18:30))
);
Source

pub const fn checked_sub(self, duration: Duration) -> Option<UtcDateTime>

Computes self - duration, returning None if an overflow occurred.

assert_eq!(UtcDateTime::MIN.checked_sub(2.days()), None);
assert_eq!(UtcDateTime::MAX.checked_sub((-1).days()), None);
assert_eq!(
    utc_datetime!(2019-11-25 15:30).checked_sub(27.hours()),
    Some(utc_datetime!(2019-11-24 12:30))
);
Source

pub const fn saturating_add(self, duration: Duration) -> UtcDateTime

Computes self + duration, saturating value on overflow.

assert_eq!(
    UtcDateTime::MIN.saturating_add((-2).days()),
    UtcDateTime::MIN
);
assert_eq!(
    UtcDateTime::MAX.saturating_add(2.days()),
    UtcDateTime::MAX
);
assert_eq!(
    utc_datetime!(2019-11-25 15:30).saturating_add(27.hours()),
    utc_datetime!(2019-11-26 18:30)
);
Source

pub const fn saturating_sub(self, duration: Duration) -> UtcDateTime

Computes self - duration, saturating value on overflow.

assert_eq!(
    UtcDateTime::MIN.saturating_sub(2.days()),
    UtcDateTime::MIN
);
assert_eq!(
    UtcDateTime::MAX.saturating_sub((-2).days()),
    UtcDateTime::MAX
);
assert_eq!(
    utc_datetime!(2019-11-25 15:30).saturating_sub(27.hours()),
    utc_datetime!(2019-11-24 12:30)
);
Source§

impl UtcDateTime

Methods that replace part of the UtcDateTime.

Source

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

Replace the time, preserving the date.

assert_eq!(
    utc_datetime!(2020-01-01 17:00).replace_time(time!(5:00)),
    utc_datetime!(2020-01-01 5:00)
);
Source

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

Replace the date, preserving the time.

assert_eq!(
    utc_datetime!(2020-01-01 12:00).replace_date(date!(2020-01-30)),
    utc_datetime!(2020-01-30 12:00)
);
Source

pub const fn replace_year( self, year: i32, ) -> Result<UtcDateTime, ComponentRange>

Replace the year. The month and day will be unchanged.

assert_eq!(
    utc_datetime!(2022-02-18 12:00).replace_year(2019),
    Ok(utc_datetime!(2019-02-18 12:00))
);
assert!(utc_datetime!(2022-02-18 12:00).replace_year(-1_000_000_000).is_err()); // -1_000_000_000 isn't a valid year
assert!(utc_datetime!(2022-02-18 12:00).replace_year(1_000_000_000).is_err()); // 1_000_000_000 isn't a valid year
Source

pub const fn replace_month( self, month: Month, ) -> Result<UtcDateTime, ComponentRange>

Replace the month of the year.

assert_eq!(
    utc_datetime!(2022-02-18 12:00).replace_month(Month::January),
    Ok(utc_datetime!(2022-01-18 12:00))
);
assert!(utc_datetime!(2022-01-30 12:00).replace_month(Month::February).is_err()); // 30 isn't a valid day in February
Source

pub const fn replace_day(self, day: u8) -> Result<UtcDateTime, ComponentRange>

Replace the day of the month.

assert_eq!(
    utc_datetime!(2022-02-18 12:00).replace_day(1),
    Ok(utc_datetime!(2022-02-01 12:00))
);
assert!(utc_datetime!(2022-02-18 12:00).replace_day(0).is_err()); // 00 isn't a valid day
assert!(utc_datetime!(2022-02-18 12:00).replace_day(30).is_err()); // 30 isn't a valid day in February
Source

pub const fn replace_ordinal( self, ordinal: u16, ) -> Result<UtcDateTime, ComponentRange>

Replace the day of the year.

assert_eq!(utc_datetime!(2022-049 12:00).replace_ordinal(1), Ok(utc_datetime!(2022-001 12:00)));
assert!(utc_datetime!(2022-049 12:00).replace_ordinal(0).is_err()); // 0 isn't a valid ordinal
assert!(utc_datetime!(2022-049 12:00).replace_ordinal(366).is_err()); // 2022 isn't a leap year
Source

pub const fn truncate_to_day(self) -> UtcDateTime

Truncate to the start of the day, setting the time to midnight.

assert_eq!(
    utc_datetime!(2022-02-18 15:30:45.123_456_789).truncate_to_day(),
    utc_datetime!(2022-02-18 0:00)
);
Source

pub const fn replace_hour(self, hour: u8) -> Result<UtcDateTime, ComponentRange>

Replace the clock hour.

assert_eq!(
    utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_hour(7),
    Ok(utc_datetime!(2022-02-18 07:02:03.004_005_006))
);
assert!(utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_hour(24).is_err()); // 24 isn't a valid hour
Source

pub const fn truncate_to_hour(self) -> UtcDateTime

Truncate to the hour, setting the minute, second, and subsecond components to zero.

assert_eq!(
    utc_datetime!(2022-02-18 15:30:45.123_456_789).truncate_to_hour(),
    utc_datetime!(2022-02-18 15:00)
);
Source

pub const fn replace_minute( self, sunday_based_week: u8, ) -> Result<UtcDateTime, ComponentRange>

Replace the minutes within the hour.

assert_eq!(
    utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_minute(7),
    Ok(utc_datetime!(2022-02-18 01:07:03.004_005_006))
);
assert!(utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_minute(60).is_err()); // 60 isn't a valid minute
Source

pub const fn truncate_to_minute(self) -> UtcDateTime

Truncate to the minute, setting the second and subsecond components to zero.

assert_eq!(
    utc_datetime!(2022-02-18 15:30:45.123_456_789).truncate_to_minute(),
    utc_datetime!(2022-02-18 15:30)
);
Source

pub const fn replace_second( self, monday_based_week: u8, ) -> Result<UtcDateTime, ComponentRange>

Replace the seconds within the minute.

assert_eq!(
    utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_second(7),
    Ok(utc_datetime!(2022-02-18 01:02:07.004_005_006))
);
assert!(utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_second(60).is_err()); // 60 isn't a valid second
Source

pub const fn truncate_to_second(self) -> UtcDateTime

Truncate to the second, setting the subsecond components to zero.

assert_eq!(
    utc_datetime!(2022-02-18 15:30:45.123_456_789).truncate_to_second(),
    utc_datetime!(2022-02-18 15:30:45)
);
Source

pub const fn replace_millisecond( self, millisecond: u16, ) -> Result<UtcDateTime, ComponentRange>

Replace the milliseconds within the second.

assert_eq!(
    utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_millisecond(7),
    Ok(utc_datetime!(2022-02-18 01:02:03.007))
);
assert!(utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_millisecond(1_000).is_err()); // 1_000 isn't a valid millisecond
Source

pub const fn truncate_to_millisecond(self) -> UtcDateTime

Truncate to the millisecond, setting the microsecond and nanosecond components to zero.

assert_eq!(
    utc_datetime!(2022-02-18 15:30:45.123_456_789).truncate_to_millisecond(),
    utc_datetime!(2022-02-18 15:30:45.123)
);
Source

pub const fn replace_microsecond( self, microsecond: u32, ) -> Result<UtcDateTime, ComponentRange>

Replace the microseconds within the second.

assert_eq!(
    utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_microsecond(7_008),
    Ok(utc_datetime!(2022-02-18 01:02:03.007_008))
);
assert!(utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_microsecond(1_000_000).is_err()); // 1_000_000 isn't a valid microsecond
Source

pub const fn truncate_to_microsecond(self) -> UtcDateTime

Truncate to the microsecond, setting the nanosecond component to zero.

assert_eq!(
    utc_datetime!(2022-02-18 15:30:45.123_456_789).truncate_to_microsecond(),
    utc_datetime!(2022-02-18 15:30:45.123_456)
);
Source

pub const fn replace_nanosecond( self, nanosecond: u32, ) -> Result<UtcDateTime, ComponentRange>

Replace the nanoseconds within the second.

assert_eq!(
    utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_nanosecond(7_008_009),
    Ok(utc_datetime!(2022-02-18 01:02:03.007_008_009))
);
assert!(utc_datetime!(2022-02-18 01:02:03.004_005_006).replace_nanosecond(1_000_000_000).is_err()); // 1_000_000_000 isn't a valid nanosecond
Source§

impl UtcDateTime

Source

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

Format the UtcDateTime using the provided format description.

Source

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

Format the UtcDateTime using the provided format description.

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

impl UtcDateTime

Source

pub fn parse( input: &str, description: &(impl Parsable + ?Sized), ) -> Result<UtcDateTime, Parse>

Parse an UtcDateTime from the input using the provided format description. A UtcOffset is permitted, but not required to be present. If present, the value will be converted to UTC.

let format = format_description!("[year]-[month]-[day] [hour]:[minute]:[second]");
assert_eq!(
    UtcDateTime::parse("2020-01-02 03:04:05", &format)?,
    utc_datetime!(2020-01-02 03:04:05)
);

Trait Implementations§

Source§

impl Add<Duration> for UtcDateTime

Source§

fn add(self, duration: Duration) -> <UtcDateTime as Add<Duration>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = UtcDateTime

The resulting type after applying the + operator.
Source§

impl Add<Duration> for UtcDateTime

Source§

fn add(self, duration: Duration) -> <UtcDateTime as Add<Duration>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = UtcDateTime

The resulting type after applying the + operator.
Source§

impl AddAssign<Duration> for UtcDateTime

Source§

fn add_assign(&mut self, rhs: Duration)

§Panics

This may panic if an overflow occurs.

Source§

impl AddAssign<Duration> for UtcDateTime

Source§

fn add_assign(&mut self, rhs: Duration)

§Panics

This may panic if an overflow occurs.

Source§

impl Clone for UtcDateTime

Source§

fn clone(&self) -> UtcDateTime

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UtcDateTime

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for UtcDateTime

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<OffsetDateTime> for UtcDateTime

Source§

fn from(datetime: OffsetDateTime) -> UtcDateTime

§Panics

This may panic if an overflow occurs.

Source§

impl From<SystemTime> for UtcDateTime

Source§

fn from(system_time: SystemTime) -> UtcDateTime

Converts to this type from the input type.
Source§

impl From<UtcDateTime> for OffsetDateTime

Source§

fn from(datetime: UtcDateTime) -> OffsetDateTime

§Panics

This may panic if an overflow occurs.

Source§

impl Hash for UtcDateTime

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for UtcDateTime

Source§

fn cmp(&self, other: &UtcDateTime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq<OffsetDateTime> for UtcDateTime

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<SystemTime> for UtcDateTime

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<UtcDateTime> for OffsetDateTime

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq for UtcDateTime

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd<OffsetDateTime> for UtcDateTime

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl PartialOrd<SystemTime> for UtcDateTime

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl PartialOrd<UtcDateTime> for OffsetDateTime

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl PartialOrd for UtcDateTime

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl SmartDisplay for UtcDateTime

Source§

type Metadata = ()

User-provided metadata type.
Source§

fn metadata(&self, _: FormatterOptions) -> Metadata<'_, UtcDateTime>

Compute any information needed to format the value. This must, at a minimum, determine the width of the value before any padding is added by the formatter. Read more
Source§

fn fmt_with_metadata( &self, f: &mut Formatter<'_>, metadata: Metadata<'_, UtcDateTime>, ) -> Result<(), Error>

Format the value using the given formatter and metadata. The formatted output should have the width indicated by the metadata. This is before any padding is added by the formatter. Read more
Source§

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

Format the value using the given formatter. This is the same as Display::fmt. Read more
Source§

impl Sub<Duration> for UtcDateTime

Source§

fn sub(self, rhs: Duration) -> <UtcDateTime as Sub<Duration>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = UtcDateTime

The resulting type after applying the - operator.
Source§

impl Sub<Duration> for UtcDateTime

Source§

fn sub(self, duration: Duration) -> <UtcDateTime as Sub<Duration>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = UtcDateTime

The resulting type after applying the - operator.
Source§

impl Sub<OffsetDateTime> for UtcDateTime

Source§

fn sub( self, rhs: OffsetDateTime, ) -> <UtcDateTime as Sub<OffsetDateTime>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

impl Sub<SystemTime> for UtcDateTime

Source§

fn sub(self, rhs: SystemTime) -> <UtcDateTime as Sub<SystemTime>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

impl Sub<UtcDateTime> for OffsetDateTime

Source§

fn sub(self, rhs: UtcDateTime) -> <OffsetDateTime as Sub<UtcDateTime>>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

impl Sub for UtcDateTime

Source§

fn sub(self, rhs: UtcDateTime) -> <UtcDateTime as Sub>::Output

§Panics

This may panic if an overflow occurs.

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

impl SubAssign<Duration> for UtcDateTime

Source§

fn sub_assign(&mut self, rhs: Duration)

§Panics

This may panic if an overflow occurs.

Source§

impl SubAssign<Duration> for UtcDateTime

Source§

fn sub_assign(&mut self, rhs: Duration)

§Panics

This may panic if an overflow occurs.

Source§

impl TryFrom<Parsed> for UtcDateTime

Source§

type Error = TryFromParsed

The type returned in the event of a conversion error.
Source§

fn try_from( parsed: Parsed, ) -> Result<UtcDateTime, <UtcDateTime as TryFrom<Parsed>>::Error>

Performs the conversion.
Source§

impl Copy for UtcDateTime

Source§

impl Eq for UtcDateTime

Source§

impl StructuralPartialEq for UtcDateTime

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,