# Struct chrono::Date [−] [src]

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

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 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(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` and `Duration` may not.

## Implementations

### `impl<Tz: TimeZone> Date<Tz>` [src]

#### `pub fn from_utc(date: NaiveDate, offset: Tz::Offset) -> Date<Tz>` [src]

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>>` [src]

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

Panics on invalid datetime.

#### `pub fn and_hms(&self, hour: u32, min: u32, sec: u32) -> DateTime<Tz>` [src]

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>>` [src]

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>` [src]

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>>` [src]

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>` [src]

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>>` [src]

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>` [src]

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>>` [src]

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>` [src]

Makes a new `Date` for the next date.

Panics when `self` is the last representable date.

#### `pub fn succ_opt(&self) -> Option<Date<Tz>>` [src]

Makes a new `Date` for the next date.

Returns `None` when `self` is the last representable date.

#### `pub fn pred(&self) -> Date<Tz>` [src]

Makes a new `Date` for the prior date.

Panics when `self` is the first representable date.

#### `pub fn pred_opt(&self) -> Option<Date<Tz>>` [src]

Makes a new `Date` for the prior date.

Returns `None` when `self` is the first representable date.

#### `pub fn offset(&self) -> &Tz::Offset` [src]

Retrieves an associated offset from UTC.

#### `pub fn timezone(&self) -> Tz` [src]

Retrieves an associated time zone.

#### `pub fn with_timezone<Tz2: TimeZone>(&self, tz: &Tz2) -> Date<Tz2>` [src]

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: OldDuration) -> Option<Date<Tz>>` [src]

Adds given `Duration` to the current date.

Returns `None` when it will result in overflow.

#### `pub fn checked_sub_signed(self, rhs: OldDuration) -> Option<Date<Tz>>` [src]

Subtracts given `Duration` from the current date.

Returns `None` when it will result in overflow.

#### `pub fn signed_duration_since<Tz2: TimeZone>(self, rhs: Date<Tz2>) -> OldDuration` [src]

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`.

#### `pub fn naive_utc(&self) -> NaiveDate` [src]

Returns a view to the naive UTC date.

#### `pub fn naive_local(&self) -> NaiveDate` [src]

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.

### `impl<Tz: TimeZone> Date<Tz> where
Tz::Offset: Display,` [src]

#### `pub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I> where
I: Iterator<Item = B> + Clone,
B: Borrow<Item<'a>>,` [src]

Formats the date with the specified formatting items.

#### `pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>>` [src]

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

## Trait Implementations

### `impl<Tz: TimeZone> Add<Duration> for Date<Tz>` [src]

#### `type Output = Date<Tz>`

The resulting type after applying the `+` operator.

#### `fn add(self, rhs: OldDuration) -> Date<Tz>` [src]

Performs the `+` operation. Read more

### `impl<Tz: Clone + TimeZone> Clone for Date<Tz> where
Tz::Offset: Clone,` [src]

#### `fn clone(&self) -> Date<Tz>` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl<Tz: TimeZone> Copy for Date<Tz> where
<Tz as TimeZone>::Offset: Copy,` [src]

### `impl<Tz: TimeZone> Datelike for Date<Tz>` [src]

#### `fn year(&self) -> i32` [src]

Returns the year number in the calendar date.

#### `fn month(&self) -> u32` [src]

Returns the month number starting from 1. Read more

#### `fn month0(&self) -> u32` [src]

Returns the month number starting from 0. Read more

#### `fn day(&self) -> u32` [src]

Returns the day of month starting from 1. Read more

#### `fn day0(&self) -> u32` [src]

Returns the day of month starting from 0. Read more

#### `fn ordinal(&self) -> u32` [src]

Returns the day of year starting from 1. Read more

#### `fn ordinal0(&self) -> u32` [src]

Returns the day of year starting from 0. Read more

#### `fn weekday(&self) -> Weekday` [src]

Returns the day of week.

#### `fn iso_week(&self) -> IsoWeek` [src]

Returns the ISO week.

#### `fn with_year(&self, year: i32) -> Option<Date<Tz>>` [src]

Makes a new value with the year number changed. Read more

#### `fn with_month(&self, month: u32) -> Option<Date<Tz>>` [src]

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

#### `fn with_month0(&self, month0: u32) -> Option<Date<Tz>>` [src]

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

#### `fn with_day(&self, day: u32) -> Option<Date<Tz>>` [src]

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

#### `fn with_day0(&self, day0: u32) -> Option<Date<Tz>>` [src]

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

#### `fn with_ordinal(&self, ordinal: u32) -> Option<Date<Tz>>` [src]

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

#### `fn with_ordinal0(&self, ordinal0: u32) -> Option<Date<Tz>>` [src]

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

#### `fn year_ce(&self) -> (bool, u32)` [src]

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

#### `fn num_days_from_ce(&self) -> i32` [src]

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

### `impl<Tz: TimeZone> Debug for Date<Tz>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<Tz: TimeZone> Display for Date<Tz> where
Tz::Offset: Display,` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<Tz: TimeZone> Eq for Date<Tz>` [src]

### `impl<Tz: TimeZone> Hash for Date<Tz>` [src]

#### `fn hash<H: Hasher>(&self, state: &mut H)` [src]

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0 [src]

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

### `impl<Tz: TimeZone> Ord for Date<Tz>` [src]

#### `fn cmp(&self, other: &Date<Tz>) -> Ordering` [src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0 [src]

Restrict a value to a certain interval. Read more

### `impl<Tz: TimeZone, Tz2: TimeZone> PartialEq<Date<Tz2>> for Date<Tz>` [src]

#### `fn eq(&self, other: &Date<Tz2>) -> bool` [src]

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

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl<Tz: TimeZone> PartialOrd<Date<Tz>> for Date<Tz>` [src]

#### `fn partial_cmp(&self, other: &Date<Tz>) -> Option<Ordering>` [src]

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

#### `#[must_use]pub fn lt(&self, other: &Rhs) -> bool` 1.0.0 [src]

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

#### `#[must_use]pub fn le(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `#[must_use]pub fn gt(&self, other: &Rhs) -> bool` 1.0.0 [src]

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

#### `#[must_use]pub fn ge(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl<Tz: TimeZone> Send for Date<Tz> where
<Tz as TimeZone>::Offset: Send,` [src]

### `impl<Tz: TimeZone> Sub<Date<Tz>> for Date<Tz>` [src]

#### `type Output = OldDuration`

The resulting type after applying the `-` operator.

#### `fn sub(self, rhs: Date<Tz>) -> OldDuration` [src]

Performs the `-` operation. Read more

### `impl<Tz: TimeZone> Sub<Duration> for Date<Tz>` [src]

#### `type Output = Date<Tz>`

The resulting type after applying the `-` operator.

#### `fn sub(self, rhs: OldDuration) -> Date<Tz>` [src]

Performs the `-` operation. Read more

## 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

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

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

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String` [src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.