pub struct Date<Tz: TimeZone> { /* private fields */ }
Expand description
ISO 8601 calendar date with time zone.
This type should be considered ambiguous at best,
due to the inherent lack of precision required for the time zone resolution.
For serialization and deserialization uses, it is best to use NaiveDate
instead.
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 anyOffset
to the local date, as long as that offset did occur in given day. For example, if2015-03-08T01:59-08:00
is followed by2015-03-08T03:00-07:00
, it may produce either2015-03-08-08:00
or2015-03-08-07:00
but not2015-03-08+00:00
and others. -
Once constructed as a full
DateTime
,DateTime::date
and other associated methods should return those for the originalDate
. For example, ifdt = tz.ymd(y,m,d).hms(h,n,s)
were valid,dt.date() == tz.ymd(y,m,d)
. -
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
andDuration
may not.
Implementations
sourceimpl<Tz: TimeZone> Date<Tz>
impl<Tz: TimeZone> Date<Tz>
sourcepub fn from_utc(date: NaiveDate, offset: Tz::Offset) -> Date<Tz>
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.
sourcepub fn and_time(&self, time: NaiveTime) -> Option<DateTime<Tz>>
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.
Panics on invalid datetime.
sourcepub fn and_hms(&self, hour: u32, min: u32, sec: u32) -> DateTime<Tz>
pub fn and_hms(&self, hour: u32, min: u32, sec: u32) -> DateTime<Tz>
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.
sourcepub fn and_hms_opt(&self, hour: u32, min: u32, sec: u32) -> Option<DateTime<Tz>>
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.
sourcepub fn and_hms_milli(
&self,
hour: u32,
min: u32,
sec: u32,
milli: u32
) -> DateTime<Tz>
pub fn and_hms_milli(
&self,
hour: u32,
min: u32,
sec: u32,
milli: u32
) -> 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.
Panics on invalid hour, minute, second and/or millisecond.
sourcepub fn and_hms_milli_opt(
&self,
hour: u32,
min: u32,
sec: u32,
milli: u32
) -> Option<DateTime<Tz>>
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.
sourcepub fn and_hms_micro(
&self,
hour: u32,
min: u32,
sec: u32,
micro: u32
) -> DateTime<Tz>
pub fn and_hms_micro(
&self,
hour: u32,
min: u32,
sec: u32,
micro: u32
) -> 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.
Panics on invalid hour, minute, second and/or microsecond.
sourcepub fn and_hms_micro_opt(
&self,
hour: u32,
min: u32,
sec: u32,
micro: u32
) -> Option<DateTime<Tz>>
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.
sourcepub fn and_hms_nano(
&self,
hour: u32,
min: u32,
sec: u32,
nano: u32
) -> DateTime<Tz>
pub fn and_hms_nano(
&self,
hour: u32,
min: u32,
sec: u32,
nano: u32
) -> 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.
Panics on invalid hour, minute, second and/or nanosecond.
sourcepub fn and_hms_nano_opt(
&self,
hour: u32,
min: u32,
sec: u32,
nano: u32
) -> Option<DateTime<Tz>>
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.
sourcepub fn succ(&self) -> Date<Tz>
pub fn succ(&self) -> Date<Tz>
Makes a new Date
for the next date.
Panics when self
is the last representable date.
sourcepub fn succ_opt(&self) -> Option<Date<Tz>>
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.
sourcepub fn pred(&self) -> Date<Tz>
pub fn pred(&self) -> Date<Tz>
Makes a new Date
for the prior date.
Panics when self
is the first representable date.
sourcepub fn pred_opt(&self) -> Option<Date<Tz>>
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.
sourcepub fn with_timezone<Tz2: TimeZone>(&self, tz: &Tz2) -> Date<Tz2>
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).
sourcepub fn checked_add_signed(self, rhs: OldDuration) -> Option<Date<Tz>>
pub fn checked_add_signed(self, rhs: OldDuration) -> Option<Date<Tz>>
Adds given Duration
to the current date.
Returns None
when it will result in overflow.
sourcepub fn checked_sub_signed(self, rhs: OldDuration) -> Option<Date<Tz>>
pub fn checked_sub_signed(self, rhs: OldDuration) -> Option<Date<Tz>>
Subtracts given Duration
from the current date.
Returns None
when it will result in overflow.
sourcepub fn signed_duration_since<Tz2: TimeZone>(self, rhs: Date<Tz2>) -> OldDuration
pub fn signed_duration_since<Tz2: TimeZone>(self, rhs: Date<Tz2>) -> OldDuration
Subtracts another Date
from the current date.
Returns a Duration
of integral numbers.
This does not overflow or underflow at all,
as all possible output fits in the range of Duration
.
sourcepub fn naive_local(&self) -> NaiveDate
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.
sourceimpl<Tz: TimeZone> Date<Tz> where
Tz::Offset: Display,
impl<Tz: TimeZone> Date<Tz> where
Tz::Offset: Display,
sourcepub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I> where
I: Iterator<Item = B> + Clone,
B: Borrow<Item<'a>>,
pub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I> where
I: Iterator<Item = B> + Clone,
B: Borrow<Item<'a>>,
Formats the date with the specified formatting items.
sourcepub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>>
pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>>
Formats the date with the specified format string.
See the format::strftime
module
on the supported escape sequences.
Trait Implementations
sourceimpl<Tz: TimeZone> Datelike for Date<Tz>
impl<Tz: TimeZone> Datelike for Date<Tz>
sourcefn year(&self) -> i32
fn year(&self) -> i32
Returns the year number in the calendar date.
sourcefn with_year(&self, year: i32) -> Option<Date<Tz>>
fn with_year(&self, year: i32) -> Option<Date<Tz>>
Makes a new value with the year number changed. Read more
sourcefn with_month(&self, month: u32) -> Option<Date<Tz>>
fn with_month(&self, month: u32) -> Option<Date<Tz>>
Makes a new value with the month number (starting from 1) changed. Read more
sourcefn with_month0(&self, month0: u32) -> Option<Date<Tz>>
fn with_month0(&self, month0: u32) -> Option<Date<Tz>>
Makes a new value with the month number (starting from 0) changed. Read more
sourcefn with_day(&self, day: u32) -> Option<Date<Tz>>
fn with_day(&self, day: u32) -> Option<Date<Tz>>
Makes a new value with the day of month (starting from 1) changed. Read more
sourcefn with_day0(&self, day0: u32) -> Option<Date<Tz>>
fn with_day0(&self, day0: u32) -> Option<Date<Tz>>
Makes a new value with the day of month (starting from 0) changed. Read more
sourcefn with_ordinal(&self, ordinal: u32) -> Option<Date<Tz>>
fn with_ordinal(&self, ordinal: u32) -> Option<Date<Tz>>
Makes a new value with the day of year (starting from 1) changed. Read more
sourcefn with_ordinal0(&self, ordinal0: u32) -> Option<Date<Tz>>
fn with_ordinal0(&self, ordinal0: u32) -> Option<Date<Tz>>
Makes a new value with the day of year (starting from 0) changed. Read more
sourcefn year_ce(&self) -> (bool, u32)
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). Read more
sourcefn num_days_from_ce(&self) -> i32
fn num_days_from_ce(&self) -> i32
Counts the days in the proleptic Gregorian calendar, with January 1, Year 1 (CE) as day 1. Read more
sourceimpl<Tz: TimeZone> Ord for Date<Tz>
impl<Tz: TimeZone> Ord for Date<Tz>
sourceimpl<Tz: TimeZone> PartialOrd<Date<Tz>> for Date<Tz>
impl<Tz: TimeZone> PartialOrd<Date<Tz>> for Date<Tz>
sourcefn partial_cmp(&self, other: &Date<Tz>) -> Option<Ordering>
fn partial_cmp(&self, other: &Date<Tz>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl<Tz: TimeZone> Sub<Date<Tz>> for Date<Tz>
impl<Tz: TimeZone> Sub<Date<Tz>> for Date<Tz>
type Output = OldDuration
type Output = OldDuration
The resulting type after applying the -
operator.
sourcefn sub(self, rhs: Date<Tz>) -> OldDuration
fn sub(self, rhs: Date<Tz>) -> OldDuration
Performs the -
operation. Read more
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,
Auto Trait Implementations
impl<Tz> RefUnwindSafe for Date<Tz> where
<Tz as TimeZone>::Offset: RefUnwindSafe,
impl<Tz> Sync for Date<Tz> where
<Tz as TimeZone>::Offset: Sync,
impl<Tz> Unpin for Date<Tz> where
<Tz as TimeZone>::Offset: Unpin,
impl<Tz> UnwindSafe for Date<Tz> where
<Tz as TimeZone>::Offset: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more