Struct badi_date::LocalBadiDate

pub struct LocalBadiDate { /* private fields */ }

A structure that holds a date in the Badí‘ (Bahá’í) calendar with associated time zone and optional coordinates

Implementations

impl LocalBadiDate

pub fn new( year: u8, month: BadiMonth, day: u16, timezone: Tz, coordinates: Option<Coordinates>, ) -> Result<Self, BadiDateError>

Create a new LocalBadiDate given day, BadiMonth, year, with optionals Coordinates, chrono_tz::Tz; checks for validity

Trait Implementations

impl BadiDateLike for LocalBadiDate

fn year(&self) -> u8

The Bahá’í Era/Badi year [1 - 221 supported] (year 1 starts 21 March 1844)

fn month(&self) -> BadiMonth

The Badi month [1 - 19] or Ayyám-i-Há

fn day(&self) -> u16

The Badi day [1 - min(19, Ayyám-i-Há days for the year)]

fn day_of_year(&self) -> u16

The day of the current year (starting with 1 on Naw-Rúz)

fn with_day(&self, day: u16) -> Result<LocalBadiDate, BadiDateError>

Returns new BadiDateLike with the given day (checks input for validity)

fn with_ymd( &self, year: u8, month: BadiMonth, day: u16, ) -> Result<LocalBadiDate, BadiDateError>

Returns new BadiDateLike with the given year, month, and day (checks input for validity)

fn with_month(&self, month: BadiMonth) -> Result<LocalBadiDate, BadiDateError>

Returns new BadiDateLike with the given month (checks input for validity)

fn with_year(&self, year: u8) -> Result<LocalBadiDate, BadiDateError>

Returns new BadiDateLike with the given year (checks input for validity)

fn with_year_and_doy( &self, year: u8, day_of_year: u16, ) -> Result<Self, BadiDateError>

Returns new BadiDateLike with the given year and 1-based day_of_year (checks input for validity)

impl Clone for LocalBadiDate

fn clone(&self) -> LocalBadiDate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalBadiDate

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

Formats the value using the given formatter.

impl FromDateTime for LocalBadiDate

fn from_datetime( date: DateTime<Tz>, coordinates: Option<Coordinates>, ) -> Result<Self, BadiDateError>

Create a new LocalBadiDate given a local time-zoned date and coordinates

impl HolyDayProviding for LocalBadiDate

fn holy_day(&self) -> Option<BahaiHolyDay>

Gets the holy day for self.day if it is a holy day

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

Gets the next holy day, if within the supported date range

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

Gets the previous holy day, if within the supported date range

impl LocalBadiDateLike for LocalBadiDate

fn timezone(&self) -> Tz

The time zone used for conversion to/from Gregorian dates/times

fn coordinates(&self) -> Option<Coordinates>

The WGS84 GPS coordinates from which sunset is calculated These MUST match the time zone or sunset times will be wrong!

impl Ord for LocalBadiDate

fn cmp(&self, other: &Self) -> 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 LocalBadiDate

fn eq(&self, other: &Self) -> 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 LocalBadiDate

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 ToDateTime for LocalBadiDate

fn start(&self) -> DateTime<Tz>

The moment of sunset of this LocalBadiDate in local time

fn end(&self) -> DateTime<Tz>

The moment of sunset of the end of this / start of next LocalBadiDate in local time

fn midnight(&self) -> DateTime<Tz>

Midnight (in local time) of this BadiDate

impl Eq for LocalBadiDate