Struct chinese_lunisolar_calendar::LunisolarYear

pub struct LunisolarYear(/* private fields */);

農曆西曆年，農曆新年所在的西曆年份。

Implementations

impl LunisolarYear

用以建立 LunisolarYear 列舉實體的關聯函數。

pub const unsafe fn from_solar_year_unsafe(solar_year: SolarYear) -> Self

透過西曆年份來取得 LunisolarYear 實體。

Examples

use chinese_lunisolar_calendar::{LunisolarYear, SolarYear};

let lunisolar_year = unsafe {
    LunisolarYear::from_solar_year_unsafe(SolarYear::from_u16(2024))
};

Safety

必須先確認傳入的西曆年份是支援的。

pub const fn from_solar_year( solar_year: SolarYear ) -> Result<Self, LunisolarOutOfRangeError>

透過西曆年份來取得 LunisolarYear 實體。

Examples

use chinese_lunisolar_calendar::{LunisolarYear, SolarYear};

let lunisolar_year =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

impl LunisolarYear

將 LunisolarYear 列舉實體轉成其它型別的方法。

pub const fn to_heavenly_stems(self) -> HeavenlyStems

取得此西曆年中，農曆新年的中國天干。

Examples

use chinese_lunisolar_calendar::{HeavenlyStems, LunisolarYear, SolarYear};

let lunisolar_year =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(HeavenlyStems::First, lunisolar_year.to_heavenly_stems());

pub const fn to_earthly_branch(self) -> EarthlyBranch

取得此西曆年中，農曆新年的中國地支。

Examples

use chinese_lunisolar_calendar::{EarthlyBranch, LunisolarYear, SolarYear};

let lunisolar_year =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(EarthlyBranch::Fifth, lunisolar_year.to_earthly_branch());

pub const fn to_zodiac(self) -> Zodiac

取得此西曆年中，農曆新年所屬的生肖。

Examples

use chinese_lunisolar_calendar::{LunisolarYear, SolarYear, Zodiac};

let lunisolar_year =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(Zodiac::Dragon, lunisolar_year.to_zodiac());

pub const fn to_lunar_year(self) -> LunarYear

取得 LunarYear 實體。

Examples

use chinese_lunisolar_calendar::{LunarYear, LunisolarYear, SolarYear};

let lunisolar_year =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(
    LunarYear::parse_str("甲辰").unwrap(),
    lunisolar_year.to_lunar_year()
);

pub const fn to_solar_year(self) -> SolarYear

取得 SolarYear 實體。

pub const fn to_u16(self) -> u16

取得 LunisolarYear 實體所代表的西曆年份數值。

impl LunisolarYear

農曆西曆年相關計算方法。

pub const fn get_leap_lunar_month(self) -> Option<LunarMonth>

取得此年的農曆閏月月份。如果沒有的話就回傳 None。

Examples

use chinese_lunisolar_calendar::{LunarMonth, LunisolarYear, SolarYear};

let lunisolar_year_2023 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2023)).unwrap();

let lunisolar_year_2024 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(
    Some(LunarMonth::LeapSecond),
    lunisolar_year_2023.get_leap_lunar_month()
);

assert_eq!(None, lunisolar_year_2024.get_leap_lunar_month());

pub const fn get_total_days_in_leap_month(self) -> u16

計算此西曆年下的農曆閏月共有幾天。如果沒有閏月，則回傳 0。

Examples

use chinese_lunisolar_calendar::{LunisolarYear, SolarYear};

let lunisolar_year_2023 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2023)).unwrap();

let lunisolar_year_2024 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(29, lunisolar_year_2023.get_total_days_in_leap_month());

assert_eq!(0, lunisolar_year_2024.get_total_days_in_leap_month());

pub const fn get_total_days(self) -> u16

計算此西曆年下的農曆年共有幾天。

Examples

use chinese_lunisolar_calendar::{LunisolarYear, SolarYear};

let lunisolar_year_2023 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2023)).unwrap();

let lunisolar_year_2024 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(384, lunisolar_year_2023.get_total_days());

assert_eq!(354, lunisolar_year_2024.get_total_days());

pub const fn get_total_days_in_a_month( self, lunar_month: LunarMonth ) -> Option<u8>

計算此西曆年下的農曆年的某個月共有幾天。如果傳入的是閏月，但是該年沒有該閏月的話就回傳 None。

Examples

use chinese_lunisolar_calendar::{LunarMonth, LunisolarYear, SolarYear};

let lunisolar_year_2023 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2023)).unwrap();

let lunisolar_year_2024 =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2024)).unwrap();

assert_eq!(
    Some(29),
    lunisolar_year_2023.get_total_days_in_a_month(LunarMonth::First)
);
assert_eq!(
    Some(30),
    lunisolar_year_2023.get_total_days_in_a_month(LunarMonth::Second)
);
assert_eq!(
    Some(29),
    lunisolar_year_2023.get_total_days_in_a_month(LunarMonth::LeapSecond)
);
assert_eq!(
    Some(29),
    lunisolar_year_2023.get_total_days_in_a_month(LunarMonth::Third)
);
assert_eq!(
    None,
    lunisolar_year_2023.get_total_days_in_a_month(LunarMonth::LeapThird)
);

assert_eq!(
    Some(29),
    lunisolar_year_2024.get_total_days_in_a_month(LunarMonth::First)
);
assert_eq!(
    Some(30),
    lunisolar_year_2024.get_total_days_in_a_month(LunarMonth::Second)
);
assert_eq!(
    None,
    lunisolar_year_2024.get_total_days_in_a_month(LunarMonth::LeapSecond)
);
assert_eq!(
    Some(29),
    lunisolar_year_2024.get_total_days_in_a_month(LunarMonth::Third)
);
assert_eq!(
    None,
    lunisolar_year_2024.get_total_days_in_a_month(LunarMonth::LeapThird)
);

Trait Implementations

impl Clone for LunisolarYear

fn clone(&self) -> LunisolarYear

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LunisolarYear

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

Formats the value using the given formatter.

impl Display for LunisolarYear

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

Formats the value using the given formatter.

Examples

use chinese_lunisolar_calendar::{LunisolarYear, SolarYear};

let lunisolar_year =
    LunisolarYear::from_solar_year(SolarYear::from_u16(2008)).unwrap();

assert_eq!("二〇〇八", format!("{}", lunisolar_year));

impl From<LunisolarDate> for LunisolarYear

fn from(value: LunisolarDate) -> Self

Converts to this type from the input type.

impl From<LunisolarYear> for EarthlyBranch

fn from(value: LunisolarYear) -> Self

Converts to this type from the input type.

impl From<LunisolarYear> for HeavenlyStems

fn from(value: LunisolarYear) -> Self

Converts to this type from the input type.

impl From<LunisolarYear> for LunarYear

fn from(value: LunisolarYear) -> Self

Converts to this type from the input type.

impl From<LunisolarYear> for SolarYear

fn from(value: LunisolarYear) -> Self

Converts to this type from the input type.

impl From<LunisolarYear> for Zodiac

fn from(value: LunisolarYear) -> Self

Converts to this type from the input type.

impl From<LunisolarYear> for u16

fn from(value: LunisolarYear) -> Self

Converts to this type from the input type.

impl Hash for LunisolarYear

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LunisolarYear

fn cmp(&self, other: &LunisolarYear) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LunisolarYear

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

fn partial_cmp(&self, other: &LunisolarYear) -> 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 TryFrom<SolarYear> for LunisolarYear

type Error = LunisolarOutOfRangeError

The type returned in the event of a conversion error.

fn try_from(value: SolarYear) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for LunisolarYear

impl Eq for LunisolarYear

impl StructuralEq for LunisolarYear

impl StructuralPartialEq for LunisolarYear