Struct Persian

pub struct Persian;

The Persian Calendar

The Persian Calendar is a solar calendar used officially by the countries of Iran and Afghanistan and many Persian-speaking regions. It has 12 months and other similarities to the Gregorian Calendar.

This type can be used with Date to represent dates in this calendar.

Era codes

This calendar uses a single era code ap (aliases sh, hs), with Anno Persico/Anno Persarum starting the year of the Hijra. Dates before this era use negative years.

Month codes

This calendar supports 12 solar month codes ("M01" - "M12")

Implementations

impl Persian

pub fn new() -> Self

Constructs a new Persian Calendar

Trait Implementations

impl Calendar for Persian

type DateInner = PersianDateInner

The internal type used to represent dates

type Year = EraYear

The type of YearInfo returned by the date

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 from_iso(&self, iso: IsoDateInner) -> PersianDateInner

Construct the date from an ISO date

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

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

Information about the year

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

The extended year value

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 debug_name(&self) -> &'static str

Obtain a name for the calendar for debug printing

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

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

impl Clone for Persian

fn clone(&self) -> Persian

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Persian

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

Formats the value using the given formatter.

impl Default for Persian

fn default() -> Persian

Returns the “default value” for a type.

impl From<Persian> for AnyCalendar

fn from(value: Persian) -> AnyCalendar

Converts to this type from the input type.

impl Hash for Persian

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoAnyCalendar for Persian

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 Ord for Persian

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Persian

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Persian

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Persian

impl Eq for Persian

impl StructuralPartialEq for Persian

impl UnstableSealed for Persian