iztro 0.6.0

Strongly typed Zi Wei Dou Shu chart generation aligned with iztro.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Deterministic yearly-period (流年) facts derived from a target lunar year.
//!
//! This module derives one yearly period from the target lunar year. It does not
//! assemble full horoscope output, derive monthly/daily/hourly facts, attach
//! yearly decorative arrays, or render narrative text.

use crate::core::error::ChartError;
use crate::core::model::chart::{
    TemporalPalaceLayout,
    temporal_layout::{build_life_branch_palace_layout, yin_first_branch_index},
};
use crate::core::model::star::mutagen::Scope;
use lunar_lite::{EarthlyBranch, StemBranch};
use serde::{Deserialize, Serialize};

/// One 流年 period aligned to the flowing year's branch.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct YearlyPeriod {
    index: usize,
    lunar_year: i32,
    palace_branch: EarthlyBranch,
    stem_branch: StemBranch,
    palace_layout: TemporalPalaceLayout,
}

impl YearlyPeriod {
    fn new(
        index: usize,
        lunar_year: i32,
        palace_branch: EarthlyBranch,
        stem_branch: StemBranch,
        palace_layout: TemporalPalaceLayout,
    ) -> Self {
        Self {
            index,
            lunar_year,
            palace_branch,
            stem_branch,
            palace_layout,
        }
    }

    /// Returns the zero-based upstream yearly index in Yin-first order.
    pub const fn index(&self) -> usize {
        self.index
    }

    /// Returns the target lunar year this period describes.
    pub const fn lunar_year(&self) -> i32 {
        self.lunar_year
    }

    /// Returns the branch selected as the yearly Life palace.
    pub const fn palace_branch(&self) -> EarthlyBranch {
        self.palace_branch
    }

    /// Returns the target year's stem-branch pair.
    pub const fn stem_branch(&self) -> StemBranch {
        self.stem_branch
    }

    /// Returns the temporal palace-name layout for this yearly period.
    pub const fn palace_layout(&self) -> &TemporalPalaceLayout {
        &self.palace_layout
    }
}

/// Builds one 流年 period from a target lunar year.
pub fn build_yearly_period(lunar_year: i32) -> Result<YearlyPeriod, ChartError> {
    let stem_branch = StemBranch::from_lunar_year(lunar_year);
    let palace_branch = stem_branch.branch();
    let index = yin_first_branch_index(palace_branch);
    let palace_layout = build_life_branch_palace_layout(Scope::Yearly, palace_branch)?;

    Ok(YearlyPeriod::new(
        index,
        lunar_year,
        palace_branch,
        stem_branch,
        palace_layout,
    ))
}