Data tables

x_iztro::data holds two kinds of thing: the enums that run through the whole library (the types of the chart fields and of nearly every function parameter), and the input tables of the charting algorithm. Both are independent of output language — they are inputs to the algorithm, not results.

The common enums are re-exported at the crate root, so use x_iztro::*; is enough.

Enums

Nineteen enums plus StarKey. All of them implement Debug, Clone, Copy, PartialEq, Eq and serde's Serialize / Deserialize, so they compare directly and go straight into collections.

Language-independent keys: as_key / from_key

Most of the enums carry a mutually inverse pair of methods converting between a variant and its iztro i18n key string. These keys are exactly the values of the *Key fields in the DTO, and the values of the Python enums and Go constants — write the same string on any of the three sides and the predicates agree.

from_key always returns an Option, giving None for an unknown key — which is how the bindings reject invalid input.

println!("{}", StarKey::ZiweiMaj.as_key());
println!("{:?}", StarKey::from_key("taiyinMaj"));
println!("{:?}", StarKey::from_key("nosuch"));
println!("{} {}", Palace::Soul.as_key(), AstroType::Earth.as_key());
println!("{:?}", DayDivide::from_key("current"));

Output

ziweiMaj
Some(TaiyinMaj)
None
soulPalace earth
Some(Current)

The other methods

println!("{} {}", HeavenlyStem::Gui.index(), EarthlyBranch::Hai.index());
println!("{:?}", Palace::from_index(4));
println!("{}", FiveElementsClass::Wood3rd.value());
println!("{:?} {}", Gender::Female.yin_yang(), Gender::Female.yin_yang().as_str());
println!("{} {:?}", Language::JaJP.as_code(), Language::from_code("ZH-cn"));

Output

9 11
Career
3
Yin 阴
ja-JP Some(ZhCN)

The variant listings

Only the ones not obvious at a glance are listed; the variant names of stems, branches, palaces and stars correspond one-to-one with their keys.

Scope has one member fewer than HoroscopeName: Childhood. The childhood scope is not a query layer of its own, only a display name for the decadal scope — before the decadal scope begins, h.decadal.name shows the childhood name, while Scope::Decadal is used as usual.

TimeIndex is a type alias for u8, purely a readability marker with no extra validation.

Config

The charting configuration: six switches plus two optional custom tables. Config::default() matches the JS iztro defaults.

The meaning of the six switches and the schools behind them are on Config in depth.

Construction methods

The fields are all pub and can be set directly; the chained form is less work:

Lookup methods

Example

let cfg = Config::default()
    .with_astro_type(AstroType::Earth)
    .with_mutagens(HeavenlyStem::Geng, [
        StarKey::TaiyangMaj, StarKey::WuquMaj, StarKey::TianfuMaj, StarKey::TiantongMaj,
    ]);

println!("{:?}", cfg.astro_type);
println!("{:?}", cfg.mutagens_of(HeavenlyStem::Geng)
    .iter().map(|s| translate_star(*s, Language::EnUS)).collect::<Vec<_>>());
println!("{:?}", cfg.mutagens_of(HeavenlyStem::Jia)
    .iter().map(|s| translate_star(*s, Language::EnUS)).collect::<Vec<_>>());
println!("{:?}", cfg.brightness_of(StarKey::ZiweiMaj, 4));

let chart = by_solar("2000-8-16", 2, Gender::Female, true, Language::EnUS, cfg)?;
println!("{}", translate_five_elements_class(chart.five_elements_class, Language::EnUS));

Output

Earth
["sun", "general", "empress", "fortunate"]
["judge", "rebel", "general", "sun"]
Some(Miao)
earth 5th

The mutagens of the geng stem have been replaced with "Taiyang lu, Wuqu quan, Tianfu ke, Tiantong ji" (the default table has Taiyin taking ke); the jia stem was not overridden and still uses the default table.

Edge cases and pitfalls

TableOverrides

The carrier of those two tables inside Config. There is usually no need to build one directly — the two with_* methods above are enough. Build one yourself when you need to load several entries at once:

Note how these differ from the methods of the same name on Config: TableOverrides::mutagens_of reports only whether there is an override, while Config::mutagens_of reports the table actually in effect (falling back to the default when there is none).

flow_star_counterparts

Purpose The full table mapping flowing stars to their natal minor-star counterparts (50 entries).

Signature

pub fn flow_star_counterparts() -> Vec<(StarKey, StarKey)>
pub fn natal_counterpart_of_flow_star(key: StarKey) -> Option<StarKey>

Both are re-exported at the crate root (use x_iztro::* brings them in). Each entry of the full table is (flowing star, natal minor-star counterpart), e.g. (StarKey::Liuchang, StarKey::WenchangMin); the single-lookup form returns None for a non-flowing star. Flowing stars have no knowledge-pack entries of their own — their readings are looked up via the natal counterpart, and this table is the official mapping.

get_star_info

Purpose Get a star's brightness table, five element and polarity.

Signature

pub fn get_star_info(key: StarKey) -> Option<StarInfo>

Parameters

Return value Option<StarInfo>. Only twenty stars have an entry; the rest return None.

The fields of StarInfo:

The twenty with entries are the fourteen major stars plus Wenchang, Wenqu, Huoxing, Lingxing, Qingyang and Tuoluo — exactly those listed in the STARS_WITH_INFO constant.

Example

let info = data::stars::get_star_info(StarKey::ZiweiMaj).unwrap();

println!("five element {:?} polarity {:?}", info.five_elements, info.yin_yang);
println!("brightness in the Yin palace {:?}", info.brightness[0]);
println!("Lucun has an entry: {}", data::stars::get_star_info(StarKey::LucunMin).is_some());

Output

five element Some(Earth) polarity Some(Yin)
brightness in the Yin palace Some(Wang)
Lucun has an entry: false

Edge cases and pitfalls

get_heavenly_stem_info

Purpose Get a heavenly stem's polarity, five element, clashing stem and four mutagen stars.

Zi Wei meaning The mutagen table of the stems is the root of the whole mutagen system: the birth-year stem determines the natal mutagens, a palace stem determines what that palace flies, and a scope stem determines that layer's mutagens.

Signature

pub fn get_heavenly_stem_info(stem: HeavenlyStem) -> HeavenlyStemInfo

Return value HeavenlyStemInfo, with fields:

Example

let jia = data::heavenly_stems::get_heavenly_stem_info(HeavenlyStem::Jia);

println!("{:?} {:?} clashes with {:?}", jia.yin_yang, jia.five_elements, jia.crash);
println!("{:?}", jia.mutagen.iter().map(|s| translate_star(*s, Language::EnUS)).collect::<Vec<_>>());

println!("wu clashes with {:?}", data::heavenly_stems::get_heavenly_stem_info(HeavenlyStem::Wu).crash);

Output

Yang Wood clashes with Some(Geng)
["judge", "rebel", "general", "sun"]
wu clashes with None

get_earthly_branch_info

Purpose Get an earthly branch's polarity, five element, clashing branch, soul and body stars and bodily correspondences.

Signature

pub fn get_earthly_branch_info(branch: EarthlyBranch) -> EarthlyBranchInfo

Return value EarthlyBranchInfo, with fields:

Example

let zi = data::earthly_branches::get_earthly_branch_info(EarthlyBranch::Zi);

println!("{:?} {:?} clashes with {:?}", zi.yin_yang, zi.five_elements, zi.crash);
println!("soul {} body {}", translate_star(zi.soul, Language::EnUS), translate_star(zi.body, Language::EnUS));
println!("{} / {}", zi.inside, zi.outside);

Output

Yang Water clashes with Wu
soul wolf body impulsive
胆 / 下体

Ordering constants

TIGER_RULE and RAT_RULE are indexed by stem ordinal: TIGER_RULE[0] is the first-month stem for a jia year.

Example

use x_iztro::data::constants::*;

println!("{} {} {}", LANGUAGES[0], ZODIAC[0], CHINESE_TIME[12]);
println!("{}", TIME_RANGES[2]);
println!("first-month stem of a jia year {}", translate_heavenly_stem(TIGER_RULE[0], Language::EnUS));
println!("Zi-hour stem of a jia day {}", translate_heavenly_stem(RAT_RULE[0], Language::EnUS));

Output

en-US rat lateRatHour
03:00~05:00
first-month stem of a jia year bing
Zi-hour stem of a jia day jia

Star enum listings

Example

println!("{} {}", data::stars::ALL_STARS.len(), data::stars::STARS_WITH_INFO.len());

// list every star that has a brightness table
for star in data::stars::STARS_WITH_INFO {
    print!("{} ", translate_star(star, Language::EnUS));
}

Output

162 20
emperor advisor sun general fortunate judge empress moon wolf advocator minister sage marshal rebel scholar artist impulsive spark driven tangled

get_brightness_table

Purpose Get a star's twelve-palace brightness table as written in the data.

Signature

pub fn get_brightness_table(key: StarKey) -> Option<[Option<Brightness>; 12]>

Return value A fixed array of twelve with index 0 being the Yin palace; None in any palace with no brightness. Stars with no brightness table return the outer None.

Example

let t = data::stars::get_brightness_table(StarKey::ZiweiMaj).unwrap();
println!("{:?}", &t[..4]);
println!("{:?}", data::stars::get_brightness_table(StarKey::LucunMin).is_none());

Output

[Some(Wang), Some(Wang), Some(De), Some(Wang)]
true

Edge cases and pitfalls