Struct holiday::Holiday

pub struct Holiday<S> { /* fields omitted */ }

An annually repeating calendar date. Can be either a fixed date (e.g., April 1) or an nth weekday of the month (e.g., 4th Thursday in November)

Methods

impl<S: ToString> Holiday<S>

pub fn new_fixed<M: Into<Month>>(name: S, month: M, day: u32) -> Self

Creates a new fixed date holiday

pub fn new_nth<N: Into<NthWeekday>>(
    name: S,
    nth: N,
    weekday: Weekday,
    month: u32
) -> Self

Creates a new nth weekday of the month Holiday

pub fn name(&self) -> &S

Returns a reference to the Name of the Holiday

pub fn iter(&self) -> HolidayIter<Self>

Returns an iterator over all the occurrences of a given Holiday starting at the earliest representable date.

pub fn in_year(&self, year: i32) -> NaiveDate

Determine the date of a Holiday in a given year

Trait Implementations

impl<S: ToString> BeforeAfterDate for Holiday<S>

fn after(&self, date: &NaiveDate) -> NaiveDate

The next occurrence after a given date

fn before(&self, date: &NaiveDate) -> NaiveDate

The previous occurrence before a given date

fn after_today(&self) -> NaiveDate

The next occurrence including today (successor)

fn before_today(&self) -> NaiveDate

The previous occurrence excluding today (predecessor)

fn first_date(&self) -> NaiveDate

The first representable occurrence of the date

fn last_date(&self) -> NaiveDate

The last representable occurrence of the date

impl<S: Clone> Clone for Holiday<S>

fn clone(&self) -> Holiday<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for Holiday<S>

impl<S: Debug> Debug for Holiday<S>

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

Formats the value using the given formatter.

impl<S: ToString> Eq for Holiday<S>

impl<'_> FromStr for Holiday<&'_ str>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'h, S: ToString> IntoIterator for &'h Holiday<S>

type Item = NaiveDate

The type of the elements being iterated over.

type IntoIter = HolidayIter<'h, Holiday<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S: ToString> Ord for Holiday<S>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<S: ToString> PartialEq<Holiday<S>> for Holiday<S>

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

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

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

This method tests for !=.

impl<S: ToString> PartialEq<NaiveDate> for Holiday<S>

fn eq(&self, date: &NaiveDate) -> bool

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

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

This method tests for !=.

impl<S: ToString> PartialEq<NthWeekdayOfMonth> for Holiday<S>

fn eq(&self, nth: &NthWeekdayOfMonth) -> bool

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

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

This method tests for !=.

impl<S: ToString> PartialOrd<Holiday<S>> for Holiday<S>

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

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

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

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

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

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

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

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

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

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