Struct WeekInformation

#[non_exhaustive]
pub struct WeekInformation {
    pub first_weekday: Weekday,
    pub weekend: WeekdaySet,
}

Information about the first day of the week and the weekend.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

first_weekday: Weekday

The first day of a week.

weekend: WeekdaySet

The set of weekend days

Implementations

impl WeekInformation

pub fn try_new(prefs: WeekPreferences) -> Result<WeekInformation, DataError>

Creates a new [WeekCalculator] from compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: WeekPreferences, ) -> Result<WeekInformation, DataError>

A version of [Self :: try_new] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_unstable<P>( provider: &P, prefs: WeekPreferences, ) -> Result<WeekInformation, DataError>

where P: DataProvider<CalendarWeekV1> + ?Sized,

A version of Self::try_new that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn weekend(self) -> WeekdaySetIterator

Weekdays that are part of the ‘weekend’, for calendar purposes. Days may not be contiguous, and order is based off the first weekday.

Trait Implementations

impl Clone for WeekInformation

fn clone(&self) -> WeekInformation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeekInformation

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

Formats the value using the given formatter.

impl Copy for WeekInformation