Struct holding_kronos::Calendar

pub struct Calendar { /* fields omitted */ }

Allows manipulation of dates.

Implementations

impl Calendar

pub fn new(months: Vec<Month>, week_days: Week, eras: Eras) -> Self

Creates a new Calendar given a number of months, week days, and eras.

pub fn hours_in_day(&self) -> u32

Gets the hours in the day for this calendar.

pub fn days_in_year(&self) -> u32

Gets the days in a year for this calendar.

pub fn days_in_week(&self) -> u32

Gets the days in a year for this calendar.

pub fn years_to_seconds(&self, years: i64) -> i64

Gets the number of seconds corresponding to a number of years.

pub fn months_to_seconds(&self, month: u32) -> u32

Given a month, calculates the seconds that pass between the beginning of the year and the end of that month.

Note that since months are irregular (have different lengths) this is always relative to the start of the year.

Example: calendar.months_to_seconds(3) = January + February + March

todo(arlyon) return result if month is out of range

pub fn days_to_seconds(&self, days: u32) -> u32

Gets the number of seconds corresponding to a number of days.

pub fn hours_to_seconds(&self, hours: u32) -> u32

Gets the number of seconds corresponding to a number of hours.

pub fn minutes_to_seconds(&self, minutes: u32) -> u32

Gets the number of seconds corresponding to a number of minutes.

pub fn years(&self, seconds: i64) -> i64

Extracts the year component from a time. This does not respect the era. In that case please use Calendar::year.

The year component is 0-indexed.

pub fn months(&self) -> &[Month]

Gets the list of months in this calendar.

pub fn month(&self, seconds: i64) -> u32

Extracts the month component from a time.

The month component is 1-indexed.

pub fn day(&self, seconds: i64) -> u32

Extracts the days component from a time.

The day component is 1-indexed.

pub fn hour(&self, seconds: i64) -> u32

Extracts the hours component from a time.

The hour component is 0-indexed.

pub fn minute(&self, seconds: i64) -> u32

Extracts the minutes component from a time.

The minutes component is 0-indexed.

pub fn second(&self, seconds: i64) -> u32

Extracts the seconds component from a time.

The seconds component is 0-indexed.

pub fn eras(&self) -> &[Era]

Gets a slice into the Eras in this calendar.

pub fn get_era(&self, year: i64) -> (usize, &Era)

Gets an era by year.

pub fn week_day(&self, era: usize, seconds: i64) -> usize

Gets the day of the week for a given DateTime.

This requires the era because the number of days in a year is not alwyas 0 modulo the days in the week.

This is 1-indexed.

pub fn week_day_name(&self, era: usize, seconds: i64) -> &str

Gets the name of the week for a given time.

pub fn month_day(&self, seconds: i64) -> u32

Gets the day of the month for a given DateTime.

The month-day component is 1-indexed.

pub fn month_name(&self, seconds: i64) -> &str

Gets the name of the month for a given DateTime.

pub fn time(&self, seconds: i64) -> u32

Get the time component (ie. modulo days).

This is nonnegative.

pub fn year(&self, era: usize, seconds: i64) -> i64

Gets the year at an offset to a given era.

The year component is 1-indexed.

pub fn parse<'a>(
    &'a self,
    date_string: &str,
    relative_to: Option<DateTime>
) -> Result<DateTime, DateTimeParseError>

Parses human times such as 1d8h43m into datetime objects according to the rules of the calendar.

1101-02-12 - some specific date 8am, 2pm - some specific time 1y32mo6d3s - relative from some time long rest - exactly 8 hours short rest - exactly 4 hours

Trait Implementations

impl Clone for Calendar

fn clone(&self) -> Calendar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Calendar

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

Formats the value using the given formatter.

impl Default for Calendar

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Calendar

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Calendar

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.