Struct icu_capi::datetime::ffi::DateTime

pub struct DateTime(pub DateTime<Arc<AnyCalendar>>);

An ICU4X DateTime object capable of containing a date and time for any calendar.

Tuple Fields

0: DateTime<Arc<AnyCalendar>>

Implementations

impl DateTime

pub fn from_iso_in_calendar( year: i32, month: u8, day: u8, hour: u8, minute: u8, second: u8, nanosecond: u32, calendar: &Calendar, ) -> Result<Box<DateTime>, CalendarError>

Creates a new DateTime representing the ISO date and time given but in a given calendar

pub fn from_codes_in_calendar( era_code: &DiplomatStr, year: i32, month_code: &DiplomatStr, day: u8, hour: u8, minute: u8, second: u8, nanosecond: u32, calendar: &Calendar, ) -> Result<Box<DateTime>, CalendarError>

Creates a new DateTime from the given codes, which are interpreted in the given calendar system

An empty era code will treat the year as an extended year

pub fn from_date_and_time(date: &Date, time: &Time) -> Box<DateTime>

Creates a new DateTime from an Date and Time object

pub fn from_string(v: &DiplomatStr) -> Result<Box<DateTime>, CalendarParseError>

Creates a new DateTime from an IXDTF string.

pub fn date(&self) -> Box<Date>

Gets a copy of the date contained in this object

pub fn time(&self) -> Box<Time>

Gets the time contained in this object

pub fn to_iso(&self) -> Box<IsoDateTime>

Converts this date to ISO

pub fn to_calendar(&self, calendar: &Calendar) -> Box<DateTime>

Convert this datetime to one in a different calendar

pub fn hour(&self) -> u8

Returns the hour in this time

pub fn minute(&self) -> u8

Returns the minute in this time

pub fn second(&self) -> u8

Returns the second in this time

pub fn nanosecond(&self) -> u32

Returns the nanosecond in this time

pub fn day_of_year(&self) -> u16

Returns the 1-indexed day in the year for this date

pub fn day_of_month(&self) -> u8

Returns the 1-indexed day in the month for this date

pub fn day_of_week(&self) -> IsoWeekday

Returns the day in the week for this day

pub fn week_of_month(&self, first_weekday: IsoWeekday) -> u8

Returns the week number in this month, 1-indexed, based on what is considered the first day of the week (often a locale preference).

first_weekday can be obtained via first_weekday() on WeekCalculator

pub fn week_of_year(&self, calculator: &WeekCalculator) -> WeekOf

Returns the week number in this year, using week data

pub fn ordinal_month(&self) -> u8

Returns 1-indexed number of the month of this date in its year

Note that for lunar calendars this may not lead to the same month having the same ordinal month across years; use month_code if you care about month identity.

pub fn month_code(&self, write: &mut DiplomatWrite)

Returns the month code for this date. Typically something like “M01”, “M02”, but can be more complicated for lunar calendars.

pub fn month_number(&self) -> u8

Returns the month number of this month.

pub fn month_is_leap(&self) -> bool

Returns whether the month is a leap month.

pub fn year_in_era(&self) -> i32

Returns the year number in the current era for this date

For calendars without an era, returns the extended year

pub fn extended_year(&self) -> i32

Returns the extended year in the Date

pub fn era(&self, write: &mut DiplomatWrite)

Returns the era for this date, or an empty string

pub fn months_in_year(&self) -> u8

Returns the number of months in the year represented by this date

pub fn days_in_month(&self) -> u8

Returns the number of days in the month represented by this date

pub fn days_in_year(&self) -> u16

Returns the number of days in the year represented by this date

pub fn calendar(&self) -> Box<Calendar>

Returns the Calendar object backing this date