Struct icu_calendar::islamic::IslamicUmmAlQura

pub struct IslamicUmmAlQura {
    data: Option<DataPayload<IslamicUmmAlQuraCacheV1Marker>>,
}

Umm al-Qura Hijri Calendar (Used in Saudi Arabia)

Era codes

This calendar supports a single era code, Anno Mundi, with code "ah"

Month codes

This calendar is a pure lunar calendar with no leap months. It uses month codes "M01" - "M12".

Fields

data: Option<DataPayload<IslamicUmmAlQuraCacheV1Marker>>

Implementations

impl IslamicUmmAlQura

pub const fn new() -> Self

Creates a new IslamicUmmAlQura with some compiled data containing precomputed calendrical calculations.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

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

A version of Self::new that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_unstable<D: DataProvider<IslamicUmmAlQuraCacheV1Marker> + ?Sized>( provider: &D, ) -> Result<Self, CalendarError>

A version of Self::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 new_always_calculating() -> Self

Construct a new IslamicUmmAlQura without any precomputed calendrical calculations.

impl IslamicUmmAlQura

fn precomputed_data(&self) -> IslamicPrecomputedData<'_, SaudiIslamicMarker>

fn year_as_islamic(year: i32) -> FormattableYear

pub(crate) const DEBUG_NAME: &'static str = "Islamic (Umm al-Qura)"

Trait Implementations

impl Calendar for IslamicUmmAlQura

type DateInner = IslamicUmmAlQuraDateInner

The internal type used to represent dates

fn date_from_codes( &self, era: Era, year: i32, month_code: MonthCode, day: u8, ) -> Result<Self::DateInner, CalendarError>

Construct a date from era/month codes and fields

fn date_from_iso(&self, iso: Date<Iso>) -> Self::DateInner

Construct the date from an ISO date

fn date_to_iso(&self, date: &Self::DateInner) -> Date<Iso>

Obtain an ISO date from this date

fn months_in_year(&self, date: &Self::DateInner) -> u8

Count the number of months in a given year, specified by providing a date from that year

fn days_in_year(&self, date: &Self::DateInner) -> u16

Count the number of days in a given year, specified by providing a date from that year

fn days_in_month(&self, date: &Self::DateInner) -> u8

Count the number of days in a given month, specified by providing a date from that year/month

fn debug_name(&self) -> &'static str

Obtain a name for the calendar for debug printing

fn year(&self, date: &Self::DateInner) -> FormattableYear

The calendar-specific year represented by date

fn is_in_leap_year(&self, date: &Self::DateInner) -> bool

Calculate if a date is in a leap year

fn month(&self, date: &Self::DateInner) -> FormattableMonth

The calendar-specific month represented by date

fn day_of_month(&self, date: &Self::DateInner) -> DayOfMonth

The calendar-specific day-of-month represented by date

fn day_of_year_info(&self, date: &Self::DateInner) -> DayOfYearInfo

Information of the day of the year

fn any_calendar_kind(&self) -> Option<AnyCalendarKind>

The AnyCalendarKind corresponding to this calendar, if one exists. Implementors outside of icu::calendar should return None

fn day_of_week(&self, date: &Self::DateInner) -> IsoWeekday

Calculate the day of the week and return it

impl CalendarArithmetic for IslamicUmmAlQura

type YearInfo = IslamicYearInfo

In case we plan to cache per-year data, this stores useful computational information for the current year as a field on ArithmeticDate

fn month_days(_year: i32, month: u8, year_info: IslamicYearInfo) -> u8

fn months_for_every_year(_year: i32, _year_info: IslamicYearInfo) -> u8

fn days_in_provided_year(_year: i32, year_info: IslamicYearInfo) -> u16

Calculate the days in a given year Can be overridden with simpler implementations for solar calendars (typically, 366 in leap, 365 otherwise) Leave this as the default for lunar calendars

fn is_leap_year(_year: i32, year_info: IslamicYearInfo) -> bool

fn last_month_day_in_year(year: i32, year_info: IslamicYearInfo) -> (u8, u8)

impl Clone for IslamicUmmAlQura

fn clone(&self) -> IslamicUmmAlQura

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IslamicUmmAlQura

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

Formats the value using the given formatter.

impl Default for IslamicUmmAlQura

fn default() -> IslamicUmmAlQura

Returns the “default value” for a type.

impl IntoAnyCalendar for IslamicUmmAlQura

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn to_any_cloned(&self) -> AnyCalendar

Convert this calendar into an AnyCalendar, cloning it

fn date_to_any(&self, d: &Self::DateInner) -> AnyDateInner

Convert a date for this calendar into an AnyDateInner