Struct icu_calendar::week::WeekCalculator

#[non_exhaustive]
pub struct WeekCalculator {
    pub first_weekday: IsoWeekday,
    pub min_week_days: u8,
    pub weekend: Option<WeekdaySet>,
}

Calculator for week-of-month and week-of-year based on locale-specific configurations.

Note that things get subtly tricky for weeks that straddle the boundary between two years: different locales may consider them as belonging to the preceding or succeeding year based on where exactly the week gets split. While this struct can be populated by values supplied by the programmer, we do recommend using one of the constructors to get locale data.

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: IsoWeekday

The first day of a week.

min_week_days: u8

For a given week, the minimum number of that week’s days present in a given month or year for the week to be considered part of that month or year.

weekend: Option<WeekdaySet>

The set of weekend days, if available

Implementations

impl WeekCalculator

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

Creates a new WeekCalculator from compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: WeekPreferences, ) -> Result<Self, DataError>

A version of [Self :: try_new] that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: WeekPreferences, ) -> Result<Self, 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<Self, DataError>

where P: DataProvider<WeekDataV2Marker> + ?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 week_of_month( &self, day_of_month: DayOfMonth, iso_weekday: IsoWeekday, ) -> WeekOfMonth

Returns the week of month according to a calendar with min_week_days = 1.

This is different from what the UTS35 spec describes 1 but the latter is missing a month of week-of-month field so following the spec would result in inconsistencies (e.g. in the ISO calendar 2021-01-01 is the last week of December but ‘MMMMW’ would have it formatted as ‘week 5 of January’).

Examples

use icu::calendar::types::{DayOfMonth, IsoWeekday, WeekOfMonth};
use icu::calendar::week::WeekCalculator;

let week_calculator =
    WeekCalculator::try_new(icu::locale::locale!("und-GB").into())
        .expect("locale should be present");

// Wednesday the 10th is in week 2:
assert_eq!(
    WeekOfMonth(2),
    week_calculator.week_of_month(DayOfMonth(10), IsoWeekday::Wednesday)
);

pub fn week_of_year( &self, day_of_year_info: DayOfYearInfo, iso_weekday: IsoWeekday, ) -> WeekOf

Returns the week of year according to the weekday and DayOfYearInfo.

Examples

use icu::calendar::types::IsoWeekday;
use icu::calendar::week::{RelativeUnit, WeekCalculator, WeekOf};
use icu::calendar::Date;

let week_calculator =
    WeekCalculator::try_new(icu::locale::locale!("und-GB").into())
        .expect("locale should be present");

let iso_date = Date::try_new_iso(2022, 8, 26).unwrap();

// Friday August 26 is in week 34 of year 2022:
assert_eq!(
    WeekOf {
        unit: RelativeUnit::Current,
        week: 34
    },
    week_calculator
        .week_of_year(iso_date.day_of_year_info(), IsoWeekday::Friday)
);

pub fn weekend(&self) -> impl Iterator<Item = IsoWeekday>

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 WeekCalculator

fn clone(&self) -> WeekCalculator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeekCalculator

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

Formats the value using the given formatter.

impl Default for WeekCalculator

fn default() -> Self

Returns the “default value” for a type.

impl Copy for WeekCalculator