Struct ISOWeekDate 

pub struct ISOWeekDate { /* private fields */ }

An ISO 8601 civil week date.

An ISO 8601 civil week date can be infallibly converted to and from Gregorian Date values.

Implementations

impl ISOWeekDate

pub const MIN: ISOWeekDate

The maximum representable ISO week date.

pub const MAX: ISOWeekDate

The minimum representable ISO week date.

pub const ZERO: ISOWeekDate

The zero ISO 8601 week date. It is the first day of the zeroth year.

pub const fn new( year: i16, week: i8, weekday: Weekday, ) -> Result<ISOWeekDate, RangeError>

Create a new ISO week date from its constituent parts.

If the week date is invalid or any of the values are out of their supported ranges, then an error is returned.

pub const fn new_constrain( year: i16, week: i8, weekday: Weekday, ) -> Result<ISOWeekDate, RangeError>

Like ISOWeekDate::new, but constrains out-of-bounds week and weekday values to their closest valid equivalent.

For example, given 9999 W52 Saturday, this will return 9999 W52 Friday.

This still returns an error when week < 1 or when year is invalid.

pub const fn year(self) -> i16

Returns the year component of this ISO 8601 week date.

The value returned is guaranteed to be in the range specified by ISOYear.

pub const fn week(self) -> i8

Returns the week number component of this ISO 8601 week date.

The value returned is guaranteed to be in the range specified by ISOWeek.

pub const fn weekday(self) -> Weekday

Returns the weekday component of this ISO 8601 week date.

pub const fn first_of_week(self) -> Result<ISOWeekDate, RangeError>

Returns the ISO 8601 week date corresponding to the first day in the week of this week date. The date returned is guaranteed to have a weekday of Weekday::Monday.

Errors

Since -9999-01-01 falls on a Monday, it follows that the minimum supported Gregorian date is exactly equivalent to the minimum supported ISO 8601 week date. This means that this routine can never actually fail, but only insomuch as the minimums line up. For that reason, and for consistency with ISOWeekDate::last_of_week, the API is fallible.

pub const fn last_of_week(self) -> Result<ISOWeekDate, RangeError>

Returns the ISO 8601 week date corresponding to the last day in the week of this week date. The date returned is guaranteed to have a weekday of Weekday::Sunday.

Errors

This can return an error if the last day of the week exceeds Jiff’s maximum Gregorian date of 9999-12-31. It turns out this can happen since 9999-12-31 falls on a Friday.

pub const fn first_of_year(self) -> Result<ISOWeekDate, RangeError>

Returns the ISO 8601 week date corresponding to the first day in the year of this week date. The date returned is guaranteed to have a weekday of Weekday::Monday.

Errors

Since -9999-01-01 falls on a Monday, it follows that the minimum support Gregorian date is exactly equivalent to the minimum supported ISO 8601 week date. This means that this routine can never actually fail, but only insomuch as the minimums line up. For that reason, and for consistency with ISOWeekDate::last_of_year, the API is fallible.

pub const fn last_of_year(self) -> Result<ISOWeekDate, RangeError>

Returns the ISO 8601 week date corresponding to the last day in the year of this week date. The date returned is guaranteed to have a weekday of Weekday::Sunday.

Errors

This can return an error if the last day of the year exceeds Jiff’s maximum Gregorian date of 9999-12-31. It turns out this can happen since 9999-12-31 falls on a Friday.

pub const fn days_in_year(self) -> i16

Returns the total number of days in the year of this ISO 8601 week date.

It is guaranteed that the value returned is either 364 or 371. The latter case occurs precisely when ISOWeekDate::in_long_year returns true.

pub const fn weeks_in_year(self) -> i8

Returns the total number of weeks in the year of this ISO 8601 week date.

It is guaranteed that the value returned is either 52 or 53. The latter case occurs precisely when ISOWeekDate::in_long_year returns true.

pub const fn in_long_year(self) -> bool

Returns true if and only if the year of this week date is a “long” year.

A long year is one that contains precisely 53 weeks. All other years contain precisely 52 weeks.

pub const fn tomorrow(self) -> Result<ISOWeekDate, RangeError>

Returns the ISO 8601 date immediately following this one.

Errors

This returns an error when this date is the maximum value.

pub fn yesterday(self) -> Result<ISOWeekDate, RangeError>

Returns the ISO 8601 week date immediately preceding this one.

Errors

This returns an error when this date is the minimum value.

pub const fn to_unix_epoch_day(self) -> UnixEpochDay

Converts this ISO 8601 week date to a Unix epoch day.

pub const fn to_date(self) -> Date

Converts this ISO 8601 week date to a Gregorian date.

Trait Implementations

impl Clone for ISOWeekDate

fn clone(&self) -> ISOWeekDate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ISOWeekDate

impl Debug for ISOWeekDate

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

Formats the value using the given formatter.

impl Eq for ISOWeekDate

impl Format for ISOWeekDate

where Weekday: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Hash for ISOWeekDate

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 Ord for ISOWeekDate

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ISOWeekDate

fn partial_cmp(&self, other: &ISOWeekDate) -> 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 StructuralPartialEq for ISOWeekDate