Struct holiday::Holiday

source ·
pub struct Holiday<S: ToString> { /* private fields */ }
Expand description

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)

Implementations§

source§

impl<S: ToString> Holiday<S>

source

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

Creates a new fixed date holiday

source

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

Creates a new nth weekday of the month Holiday

source

pub fn name(&self) -> &S

Returns a reference to the Name of the Holiday

source

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

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

source

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

Determine the date of a Holiday in a given year

Trait Implementations§

source§

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

source§

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

The next occurrence after a given date
source§

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

The previous occurrence before a given date
source§

fn after_today(&self) -> NaiveDate

The next occurrence including today (successor)
source§

fn before_today(&self) -> NaiveDate

The previous occurrence excluding today (predecessor)
source§

fn first_date(&self) -> NaiveDate

The first representable occurrence of the date
source§

fn last_date(&self) -> NaiveDate

The last representable occurrence of the date
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl FromStr for Holiday<&str>

§

type Err = Error

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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 · source§

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
1.0.0 · source§

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

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

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

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

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

source§

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

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for Holiday<S>where S: RefUnwindSafe,

§

impl<S> Send for Holiday<S>where S: Send,

§

impl<S> Sync for Holiday<S>where S: Sync,

§

impl<S> Unpin for Holiday<S>where S: Unpin,

§

impl<S> UnwindSafe for Holiday<S>where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.