Struct Date

pub struct Date<Tz: TimeZone> { /* private fields */ }

👎Deprecated since 0.4.23: Use NaiveDate or DateTime<Tz> instead

ISO 8601 calendar date with time zone.

You almost certainly want to be using a NaiveDate instead of this type.

This type primarily exists to aid in the construction of DateTimes that have a timezone by way of the TimeZone datelike constructors (e.g. TimeZone::ymd).

This type should be considered ambiguous at best, due to the inherent lack of precision required for the time zone resolution.

There are some guarantees on the usage of Date<Tz>:

• If properly constructed via TimeZone::ymd and others without an error, the corresponding local date should exist for at least a moment. (It may still have a gap from the offset changes.)

• The TimeZone is free to assign any Offset to the local date, as long as that offset did occur in given day.

  For example, if 2015-03-08T01:59-08:00 is followed by 2015-03-08T03:00-07:00, it may produce either 2015-03-08-08:00 or 2015-03-08-07:00 but not 2015-03-08+00:00 and others.

• Once constructed as a full DateTime, DateTime::date and other associated methods should return those for the original Date. For example, if dt = tz.ymd_opt(y,m,d).unwrap().hms(h,n,s) were valid, dt.date() == tz.ymd_opt(y,m,d).unwrap().

• The date is timezone-agnostic up to one day (i.e. practically always), so the local date and UTC date should be equal for most cases even though the raw calculation between NaiveDate and TimeDelta may not.

Implementations

impl<Tz: TimeZone> Date<Tz>

pub const MIN_UTC: Date<Utc> = _

The minimum possible Date.

pub const MAX_UTC: Date<Utc> = _

The maximum possible Date.

pub fn from_utc(date: NaiveDate, offset: Tz::Offset) -> Date<Tz>

Makes a new Date with given UTC date and offset. The local date should be constructed via the TimeZone trait.

pub fn and_time(&self, time: NaiveTime) -> Option<DateTime<Tz>>

Makes a new DateTime from the current date and given NaiveTime. The offset in the current date is preserved.

Returns None on invalid datetime.

pub fn and_hms(&self, hour: u32, min: u32, sec: u32) -> DateTime<Tz>

👎Deprecated since 0.4.23: Use and_hms_opt() instead

Makes a new DateTime from the current date, hour, minute and second. The offset in the current date is preserved.

Panics on invalid hour, minute and/or second.

pub fn and_hms_opt(&self, hour: u32, min: u32, sec: u32) -> Option<DateTime<Tz>>

Makes a new DateTime from the current date, hour, minute and second. The offset in the current date is preserved.

Returns None on invalid hour, minute and/or second.

pub fn and_hms_milli( &self, hour: u32, min: u32, sec: u32, milli: u32, ) -> DateTime<Tz>

👎Deprecated since 0.4.23: Use and_hms_milli_opt() instead

Makes a new DateTime from the current date, hour, minute, second and millisecond. The millisecond part can exceed 1,000 in order to represent the leap second. The offset in the current date is preserved.

Panics on invalid hour, minute, second and/or millisecond.

pub fn and_hms_milli_opt( &self, hour: u32, min: u32, sec: u32, milli: u32, ) -> Option<DateTime<Tz>>

Makes a new DateTime from the current date, hour, minute, second and millisecond. The millisecond part can exceed 1,000 in order to represent the leap second. The offset in the current date is preserved.

Returns None on invalid hour, minute, second and/or millisecond.

pub fn and_hms_micro( &self, hour: u32, min: u32, sec: u32, micro: u32, ) -> DateTime<Tz>

👎Deprecated since 0.4.23: Use and_hms_micro_opt() instead

Makes a new DateTime from the current date, hour, minute, second and microsecond. The microsecond part can exceed 1,000,000 in order to represent the leap second. The offset in the current date is preserved.

Panics on invalid hour, minute, second and/or microsecond.

pub fn and_hms_micro_opt( &self, hour: u32, min: u32, sec: u32, micro: u32, ) -> Option<DateTime<Tz>>

Makes a new DateTime from the current date, hour, minute, second and microsecond. The microsecond part can exceed 1,000,000 in order to represent the leap second. The offset in the current date is preserved.

Returns None on invalid hour, minute, second and/or microsecond.

pub fn and_hms_nano( &self, hour: u32, min: u32, sec: u32, nano: u32, ) -> DateTime<Tz>

👎Deprecated since 0.4.23: Use and_hms_nano_opt() instead

Makes a new DateTime from the current date, hour, minute, second and nanosecond. The nanosecond part can exceed 1,000,000,000 in order to represent the leap second. The offset in the current date is preserved.

Panics on invalid hour, minute, second and/or nanosecond.

pub fn and_hms_nano_opt( &self, hour: u32, min: u32, sec: u32, nano: u32, ) -> Option<DateTime<Tz>>

Makes a new DateTime from the current date, hour, minute, second and nanosecond. The nanosecond part can exceed 1,000,000,000 in order to represent the leap second. The offset in the current date is preserved.

Returns None on invalid hour, minute, second and/or nanosecond.

pub fn succ(&self) -> Date<Tz>

👎Deprecated since 0.4.23: Use succ_opt() instead

Makes a new Date for the next date.

Panics when self is the last representable date.

pub fn succ_opt(&self) -> Option<Date<Tz>>

Makes a new Date for the next date.

Returns None when self is the last representable date.

pub fn pred(&self) -> Date<Tz>

👎Deprecated since 0.4.23: Use pred_opt() instead

Makes a new Date for the prior date.

Panics when self is the first representable date.

pub fn pred_opt(&self) -> Option<Date<Tz>>

Makes a new Date for the prior date.

Returns None when self is the first representable date.

pub fn offset(&self) -> &Tz::Offset

Retrieves an associated offset from UTC.

pub fn timezone(&self) -> Tz

Retrieves an associated time zone.

pub fn with_timezone<Tz2: TimeZone>(&self, tz: &Tz2) -> Date<Tz2>

Changes the associated time zone. This does not change the actual Date (but will change the string representation).

pub fn checked_add_signed(self, rhs: TimeDelta) -> Option<Date<Tz>>

Adds given TimeDelta to the current date.

Returns None when it will result in overflow.

pub fn checked_sub_signed(self, rhs: TimeDelta) -> Option<Date<Tz>>

Subtracts given TimeDelta from the current date.

Returns None when it will result in overflow.

pub fn signed_duration_since<Tz2: TimeZone>(self, rhs: Date<Tz2>) -> TimeDelta

Subtracts another Date from the current date. Returns a TimeDelta of integral numbers.

This does not overflow or underflow at all, as all possible output fits in the range of TimeDelta.

pub fn naive_utc(&self) -> NaiveDate

Returns a view to the naive UTC date.

pub fn naive_local(&self) -> NaiveDate

Returns a view to the naive local date.

This is technically the same as naive_utc because the offset is restricted to never exceed one day, but provided for the consistency.

pub fn years_since(&self, base: Self) -> Option<u32>

Returns the number of whole years from the given base until self.

impl<Tz: TimeZone> Date<Tz>

where Tz::Offset: Display,

pub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I>

where I: Iterator<Item = B> + Clone, B: Borrow<Item<'a>>,

Available on crate feature alloc only.

Formats the date with the specified formatting items.

pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>>

Available on crate feature alloc only.

Formats the date with the specified format string. See the crate::format::strftime module on the supported escape sequences.

Trait Implementations

impl<Tz: TimeZone> Add<TimeDelta> for Date<Tz>

type Output = Date<Tz>

The resulting type after applying the + operator.

fn add(self, rhs: TimeDelta) -> Date<Tz>

Performs the + operation.

impl<Tz: TimeZone> AddAssign<TimeDelta> for Date<Tz>

fn add_assign(&mut self, rhs: TimeDelta)

Performs the += operation.

impl<Tz: Clone + TimeZone> Clone for Date<Tz>

where Tz::Offset: Clone,

fn clone(&self) -> Date<Tz>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Tz: TimeZone> Datelike for Date<Tz>

fn year(&self) -> i32

Returns the year number in the calendar date.

fn month(&self) -> u32

Returns the month number starting from 1.

fn month0(&self) -> u32

Returns the month number starting from 0.

fn day(&self) -> u32

Returns the day of month starting from 1.

fn day0(&self) -> u32

Returns the day of month starting from 0.

fn ordinal(&self) -> u32

Returns the day of year starting from 1.

fn ordinal0(&self) -> u32

Returns the day of year starting from 0.

fn weekday(&self) -> Weekday

Returns the day of week.

fn iso_week(&self) -> IsoWeek

Returns the ISO week.

fn with_year(&self, year: i32) -> Option<Date<Tz>>

Makes a new value with the year number changed, while keeping the same month and day.

fn with_month(&self, month: u32) -> Option<Date<Tz>>

Makes a new value with the month number (starting from 1) changed.

fn with_month0(&self, month0: u32) -> Option<Date<Tz>>

Makes a new value with the month number (starting from 0) changed.

fn with_day(&self, day: u32) -> Option<Date<Tz>>

Makes a new value with the day of month (starting from 1) changed.

fn with_day0(&self, day0: u32) -> Option<Date<Tz>>

Makes a new value with the day of month (starting from 0) changed.

fn with_ordinal(&self, ordinal: u32) -> Option<Date<Tz>>

Makes a new value with the day of year (starting from 1) changed.

fn with_ordinal0(&self, ordinal0: u32) -> Option<Date<Tz>>

Makes a new value with the day of year (starting from 0) changed.

fn year_ce(&self) -> (bool, u32)

Returns the absolute year number starting from 1 with a boolean flag, which is false when the year predates the epoch (BCE/BC) and true otherwise (CE/AD).

fn num_days_from_ce(&self) -> i32

Counts the days in the proleptic Gregorian calendar, with January 1, Year 1 (CE) as day 1.

impl<Tz: TimeZone> Debug for Date<Tz>

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

Formats the value using the given formatter.

impl<Tz: TimeZone> Display for Date<Tz>

where Tz::Offset: Display,

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

Formats the value using the given formatter.

impl<Tz: TimeZone> Hash for Date<Tz>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Tz: TimeZone> Ord for Date<Tz>

fn cmp(&self, other: &Date<Tz>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<Tz: TimeZone, Tz2: TimeZone> PartialEq<Date<Tz2>> for Date<Tz>

fn eq(&self, other: &Date<Tz2>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Tz: TimeZone> PartialOrd for Date<Tz>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<Tz: TimeZone> Sub<TimeDelta> for Date<Tz>

type Output = Date<Tz>

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDelta) -> Date<Tz>

Performs the - operation.

impl<Tz: TimeZone> Sub for Date<Tz>

type Output = TimeDelta

The resulting type after applying the - operator.

fn sub(self, rhs: Date<Tz>) -> TimeDelta

Performs the - operation.

impl<Tz: TimeZone> SubAssign<TimeDelta> for Date<Tz>

fn sub_assign(&mut self, rhs: TimeDelta)

Performs the -= operation.

impl<Tz: TimeZone> Copy for Date<Tz>

where <Tz as TimeZone>::Offset: Copy,

impl<Tz: TimeZone> Eq for Date<Tz>

impl<Tz: TimeZone> Send for Date<Tz>

where <Tz as TimeZone>::Offset: Send,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.