Struct Hijri 

pub struct Hijri<S>(pub S);

The Hijri Calendar

There are many variants of this calendar, using different lunar observations or calculations (see Rules). Currently, Rules is an unstable trait, but some of its implementors are stable, and can be constructed via the various Hijri::new_* constructors. Please comment on this issue if you would like to see this the ability to implement custom Rules stabilized.

This implementation supports only variants where months are either 29 or 30 days.

This corresponds to various "islamic-*" CLDR calendars, see the individual implementors of Rules (TabularAlgorithm, UmmAlQura, AstronomicalSimulation) for more information.

Era codes

This calendar uses two era codes: ah, and bh, corresponding to the Anno Hegirae and Before Hijrah eras

Months and days

The 12 months are called al-Muḥarram (M01), Ṣafar (M02), Rabīʿ al-ʾAwwal (M03), Rabīʿ ath-Thānī or Rabīʿ al-ʾĀkhir (M04), Jumādā al-ʾŪlā (M05), Jumādā ath-Thāniyah or Jumādā al-ʾĀkhirah (M06), Rajab (M07), Shaʿbān (M08), Ramaḍān (M09), Shawwāl (M10), Ḏū al-Qaʿdah (M11), Ḏū al-Ḥijjah (M12).

As a true lunar calendar, the lengths of the months depend on the lunar cycle (a month starts on the day where the waxing crescent is first observed), and will be either 29 or 30 days.

The lengths of the months are determined by the concrete Rules implementation.

There are either 6 or 7 30-day months, so the length of the year is 354 or 355 days.

Calendar drift

As a lunar calendar, this calendar does not intend to follow the solar year, and drifts more than 10 days per year with respect to the seasons.

Tuple Fields

0: S

Implementations

impl Hijri<AstronomicalSimulation>

pub const fn new_mecca() -> Self

👎Deprecated since 2.1.0:

use Hijri::new_simulated_mecca

Use Self::new_simulated_mecca.

pub const fn new_simulated_mecca() -> Self

Creates a Hijri calendar using simulated sightings at Mecca.

These simulations are unofficial and are known to not necessarily match sightings on the ground. Unless you know otherwise for sure, instead of this variant, use Hijri::new_umm_al_qura, which uses the results of KACST’s Mecca-based calculations.

pub fn try_new_mecca_unstable<D: ?Sized>( _provider: &D, ) -> Result<Self, DataError>

👎Deprecated since 2.1.0:

use Hijri::new_simulated_mecca

A version of Self::new_mecca 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 const fn new_mecca_always_calculating() -> Self

👎Deprecated since 2.1.0:

use Hijri::new_simulated_mecca

Use Self::new_simulated_mecca.

impl Hijri<UmmAlQura>

pub const fn new() -> Self

👎Deprecated since 2.1.0:

use Self::new_umm_al_qura

Use Self::new_umm_al_qura

pub const fn new_umm_al_qura() -> Self

Creates a Hijri calendar using UmmAlQura rules.

impl Hijri<TabularAlgorithm>

pub const fn new( leap_years: TabularAlgorithmLeapYears, epoch: TabularAlgorithmEpoch, ) -> Self

👎Deprecated since 2.1.0:

use Hijri::new_tabular

Use Self::new_tabular

pub const fn new_tabular( leap_years: TabularAlgorithmLeapYears, epoch: TabularAlgorithmEpoch, ) -> Self

Creates a Hijri calendar with tabular rules and the given leap year rule and epoch.

Trait Implementations

impl<R: Rules> Calendar for Hijri<R>

type DateInner = HijriDateInner<R>

The internal type used to represent dates

type Year = EraYear

The type of YearInfo returned by the date

type DifferenceError = Infallible

The type of error returned by until

fn from_codes( &self, era: Option<&str>, year: i32, month_code: MonthCode, day: u8, ) -> Result<Self::DateInner, DateError>

Construct a date from era/month codes and fields

fn from_rata_die(&self, rd: RataDie) -> Self::DateInner

Construct the date from a RataDie

fn to_rata_die(&self, date: &Self::DateInner) -> RataDie

Obtain a RataDie from this date

fn has_cheap_iso_conversion(&self) -> bool

Whether from_iso/to_iso is more efficient than from_rata_die/to_rata_die.

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_info(&self, date: &Self::DateInner) -> Self::Year

Information about the year

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) -> MonthInfo

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(&self, date: &Self::DateInner) -> DayOfYear

Information of the day of the year

fn calendar_algorithm(&self) -> Option<CalendarAlgorithm>

Returns the CalendarAlgorithm that is required to match when parsing into this calendar.

fn from_iso(&self, iso: IsoDateInner) -> Self::DateInner

Construct the date from an ISO date.

fn to_iso(&self, date: &Self::DateInner) -> IsoDateInner

Obtain an ISO date from this date.

fn extended_year(&self, date: &Self::DateInner) -> i32

The extended year.

impl<S: Clone> Clone for Hijri<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Rules> DateFieldsResolver for Hijri<R>

type YearInfo = HijriYearData

This stores the year as either an i32, or a type containing more useful computational information.

fn days_in_provided_month(year: Self::YearInfo, month: u8) -> u8

fn months_in_provided_year(_year: Self::YearInfo) -> u8

fn year_info_from_era( &self, era: &[u8], era_year: i32, ) -> Result<Self::YearInfo, UnknownEraError>

Converts the era and era year to a YearInfo. If the calendar does not have eras, this should always return an Err result.

fn year_info_from_extended(&self, extended_year: i32) -> Self::YearInfo

Converts an extended year to a YearInfo.

fn reference_year_from_month_day( &self, month_code: ValidMonthCode, day: u8, ) -> Result<Self::YearInfo, EcmaReferenceYearError>

Calculates the ECMA reference year for the month code and day, or an error if the month code and day are invalid.

fn ordinal_month_from_code( &self, _year: &Self::YearInfo, month_code: ValidMonthCode, _options: DateFromFieldsOptions, ) -> Result<u8, MonthCodeError>

Calculates the ordinal month for the given year and month code.

fn month_code_from_ordinal( &self, _year: &Self::YearInfo, ordinal_month: u8, ) -> ValidMonthCode

Calculates the month code from the given ordinal month and year.

impl<S: Debug> Debug for Hijri<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Hijri<S>

fn default() -> Hijri<S>

Returns the “default value” for a type.

impl From<Hijri<AstronomicalSimulation>> for AnyCalendar

fn from(value: Hijri<AstronomicalSimulation>) -> AnyCalendar

Converts to this type from the input type.

impl From<Hijri<TabularAlgorithm>> for AnyCalendar

fn from(value: Hijri<TabularAlgorithm>) -> AnyCalendar

Converts to this type from the input type.

impl From<Hijri<UmmAlQura>> for AnyCalendar

fn from(value: Hijri<UmmAlQura>) -> AnyCalendar

Converts to this type from the input type.

impl IntoAnyCalendar for Hijri<AstronomicalSimulation>

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn kind(&self) -> AnyCalendarKind

The AnyCalendarKind enum variant associated with this calendar

fn from_any(any: AnyCalendar) -> Result<Self, AnyCalendar>

Move an AnyCalendar into a Self, or returning it as an error if the types do not match.

fn from_any_ref(any: &AnyCalendar) -> Option<&Self>

Convert an AnyCalendar reference into a Self reference.

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

Convert a date for this calendar into an AnyDateInner

impl IntoAnyCalendar for Hijri<TabularAlgorithm>

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn kind(&self) -> AnyCalendarKind

The AnyCalendarKind enum variant associated with this calendar

fn from_any(any: AnyCalendar) -> Result<Self, AnyCalendar>

Move an AnyCalendar into a Self, or returning it as an error if the types do not match.

fn from_any_ref(any: &AnyCalendar) -> Option<&Self>

Convert an AnyCalendar reference into a Self reference.

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

Convert a date for this calendar into an AnyDateInner

impl IntoAnyCalendar for Hijri<UmmAlQura>

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn kind(&self) -> AnyCalendarKind

The AnyCalendarKind enum variant associated with this calendar

fn from_any(any: AnyCalendar) -> Result<Self, AnyCalendar>

Move an AnyCalendar into a Self, or returning it as an error if the types do not match.

fn from_any_ref(any: &AnyCalendar) -> Option<&Self>

Convert an AnyCalendar reference into a Self reference.

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

Convert a date for this calendar into an AnyDateInner

impl<S: Copy> Copy for Hijri<S>