Enum badi_date::BadiMonth

pub enum BadiMonth {
    Month(u8),
    AyyamIHa,
}

Represents one of the 19 Bahá’í months or Ayyám-i-Há

Variants

Month(u8)

One of the 19 Badi/Bahá’í months (parameter is 1-based month number)

AyyamIHa

The intercalary days of Ayyám-i-Há

Implementations

impl BadiMonth

pub fn first() -> Self

First month of the year (Bahá)

pub fn last() -> Self

Last month of the year (ʻAláʼ)

pub fn next(&self) -> Option<Self>

Next month of the year (None if self is ʻAláʼ)

pub fn previous(&self) -> Option<Self>

Previous month of the year (None if self is Bahá)

pub fn validate(&self) -> Result<Self, BadiDateError>

Return self if month is valid, otherwise BadiDateError::MonthInvalid

pub fn number_of_days(&self, year: u8) -> u16

Max number of days in the month (year required to compute Ayyám-i-Há days)

pub fn arabic(&self) -> String

Arabic name of the month in the Arabic charater set

pub fn english(&self) -> String

English name of the month (as opposed to transliteration)

pub fn transliteration(&self) -> String

English transliteration of Arabic name of the month

pub fn additional_meanings(&self) -> String

Additional meanings in authorized English translations of Baháʼí scripture https://en.wikipedia.org/wiki/Bah%C3%A1%CA%BC%C3%AD_calendar

pub fn name(&self, locale: &str) -> String

Get name of the month in a locale (see /locales/app.yaml): en: English ar: Arabic tl: English transliteration extra: Additional meanings (English)

pub fn description(&self) -> String

Get a (debug) description of the month

Trait Implementations

impl Clone for BadiMonth

fn clone(&self) -> BadiMonth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BadiMonth

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

Formats the value using the given formatter.

impl Ord for BadiMonth

fn cmp(&self, other: &BadiMonth) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for BadiMonth

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for BadiMonth

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for BadiMonth

impl Eq for BadiMonth

impl StructuralPartialEq for BadiMonth