Struct icu_calendar::japanese::Japanese

pub struct Japanese {
    eras: DataPayload<JapaneseErasV1Marker>,
}

The Japanese Calendar (with modern eras only)

The Japanese calendar is a solar calendar used in Japan, with twelve months. The months and days are identical to that of the Gregorian calendar, however the years are counted differently using the Japanese era system.

This calendar only contains eras after Meiji, for all historical eras, check out JapaneseExtended.

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

Era codes

This calendar currently supports seven era codes. It supports the five post-Meiji eras ("meiji", "taisho", "showa", "heisei", "reiwa"), as well as using the Gregorian "bce" and "ce" for dates before the Meiji era.

Future eras will also be added to this type when they are decided.

These eras are loaded from data, requiring a data provider capable of providing JapaneseErasV1Marker data (calendar/japanese@1).

Month codes

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

Fields

eras: DataPayload<JapaneseErasV1Marker>

Implementations

impl Japanese

pub const fn new() -> Self

Creates a new Japanese using only modern eras (post-meiji) from compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), ) -> Result<Self, CalendarError>

A version of Self::new that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_unstable<D: DataProvider<JapaneseErasV1Marker> + ?Sized>( provider: &D, ) -> Result<Self, CalendarError>

A version of Self::new that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

fn japanese_date_from_codes( &self, era: Era, year: i32, month_code: MonthCode, day: u8, debug_name: &'static str, ) -> Result<JapaneseDateInner, CalendarError>

pub(crate) const DEBUG_NAME: &'static str = "Japanese"

impl Japanese

fn adjusted_year_for(&self, date: &IsoDateInner) -> (i32, TinyStr16)

Given an ISO date, give year and era for that date in the Japanese calendar

This will also use Gregorian eras for eras that are before the earliest era

fn japanese_era_for(&self, date: EraStartDate) -> (EraStartDate, TinyStr16)

Given an date, obtain the era data (not counting spliced gregorian eras)

fn japanese_era_range_for( &self, era: TinyStr16, ) -> Result<(EraStartDate, Option<EraStartDate>), CalendarError>

Returns the range of dates for a given Japanese era code, not handling “bce” or “ce”

Returns (era_start, era_end)

fn new_japanese_date_inner( &self, era: Era, year: i32, month: u8, day: u8, ) -> Result<JapaneseDateInner, CalendarError>

Trait Implementations

impl Calendar for Japanese

fn year(&self, date: &Self::DateInner) -> FormattableYear

The calendar-specific year represented by date

fn month(&self, date: &Self::DateInner) -> FormattableMonth

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

Information of the day of the year

type DateInner = JapaneseDateInner

The internal type used to represent dates

fn date_from_codes( &self, era: Era, year: i32, month_code: MonthCode, day: u8, ) -> Result<Self::DateInner, CalendarError>

Construct a date from era/month codes and fields

fn date_from_iso(&self, iso: Date<Iso>) -> JapaneseDateInner

Construct the date from an ISO date

fn date_to_iso(&self, date: &Self::DateInner) -> Date<Iso>

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

Calculate if a date is in a leap year

fn debug_name(&self) -> &'static str

Obtain a name for the calendar for debug printing

fn any_calendar_kind(&self) -> Option<AnyCalendarKind>

The AnyCalendarKind corresponding to this calendar, if one exists. Implementors outside of icu::calendar should return None

fn day_of_week(&self, date: &Self::DateInner) -> IsoWeekday

Calculate the day of the week and return it

impl Clone for Japanese

fn clone(&self) -> Japanese

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Japanese

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

Formats the value using the given formatter.

impl Default for Japanese

fn default() -> Japanese

Returns the “default value” for a type.

impl IntoAnyCalendar for Japanese

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn to_any_cloned(&self) -> AnyCalendar

Convert this calendar into an AnyCalendar, cloning it

fn date_to_any(&self, d: &Self::DateInner) -> AnyDateInner

Convert a date for this calendar into an AnyDateInner