Expand description
§A library for handling traditional Japanese customs.
This library handles various information related to dates based on Japanese unique customs and practices.
This library heavily relies on the chrono
for various caluculation and comparisions.
§Overview
§Year
In Japan, in addition to Gregorian calendar, the Japanese era system is also used.
Using JapaneseEra
, it is possible to derive the Japanese era from the Gregorian calendar.
Please note that it is not possible to derive Japanese eras before the Meiji era. Prior to the Meiji era, the derivation is based on the lunar calendar, which is not currentry supported.
§Month
In Japan, there are unique names for months similar to how January is for first month and Febrary for second months in English.
By using JapaneseMonth
, it is possible to derive these.
§Weekday
Similarly to months, there are unique names for weekday in Japanese.
By using JapaneseWeekday
, it is possible to derive these.
§Day and holiday
The representation of days itself is not specifically supported by this library. However, due to the numerous unique Japanese holidays, this is supported in the library.
By using JapaneseHoliday
, it is possible to derive these.
§Calendar
It supports generating calendars using each of the above, including both common Gregorian dates and Japanese-specific expression.
By using Koyomi
, you can generate calendars.
Modules§
Structs§
- Japanese
Date - Japanese date
- Koyomi
- Japanese calendar
Enums§
- Heavenly
Stem - Heavenly stem.
- Japanese
Era - Japanese era.
- Japanese
Holiday - Japanese specific holidays.
- Japanese
Month - Japanese Months.
- Japanese
Weekday - Japanese weekdays.
- Japanese
Zodiac - Japanese zodiac
- Sexagenary
Cycle - Sexagenary cycle