iztro 0.8.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

//! Read-only context and request types for pattern detection.

use crate::core::pattern::model::PatternFamily;
use crate::core::{Chart, HoroscopeChart, Scope};

/// A read-only query wrapper over a chart for pattern detection.
///
/// The context borrows chart facts and never mutates them. When a
/// [`HoroscopeChart`] is supplied, its natal chart is used as the underlying
/// [`Chart`]; temporal layers remain overlays and are never folded into natal
/// facts.
#[derive(Clone, Debug)]
pub struct PatternContext<'a> {
    /// The natal chart facts being analyzed.
    pub chart: &'a Chart,
    /// The horoscope chart, when temporal scopes are in play.
    pub horoscope: Option<&'a HoroscopeChart>,
    /// The temporal scopes currently active for detection.
    pub active_scopes: Vec<Scope>,
}

impl<'a> PatternContext<'a> {
    /// Creates a natal-only context.
    pub fn natal(chart: &'a Chart) -> Self {
        Self {
            chart,
            horoscope: None,
            active_scopes: vec![Scope::Natal],
        }
    }

    /// Creates a context over a horoscope chart with the given active scopes.
    pub fn horoscope(chart: &'a HoroscopeChart, active_scopes: Vec<Scope>) -> Self {
        Self {
            chart: chart.natal(),
            horoscope: Some(chart),
            active_scopes,
        }
    }
}

/// A request controlling which detections [`detect_patterns`] returns.
///
/// [`detect_patterns`]: crate::core::pattern::detect_patterns
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PatternDetectionRequest {
    /// Scopes to detect within.
    pub scopes: Vec<Scope>,
    /// Whether to include [`PatternStatus::Partial`] detections.
    ///
    /// [`PatternStatus::Partial`]: crate::core::pattern::PatternStatus::Partial
    pub include_partial: bool,
    /// Whether to include [`PatternStatus::Weakened`] detections.
    ///
    /// [`PatternStatus::Weakened`]: crate::core::pattern::PatternStatus::Weakened
    pub include_weakened: bool,
    /// Whether to include [`PatternStatus::Broken`] detections.
    ///
    /// [`PatternStatus::Broken`]: crate::core::pattern::PatternStatus::Broken
    pub include_broken: bool,
    /// If non-empty, only detections in these families are returned.
    pub families: Vec<PatternFamily>,
}

impl Default for PatternDetectionRequest {
    fn default() -> Self {
        Self {
            scopes: vec![Scope::Natal],
            include_partial: false,
            include_weakened: true,
            include_broken: true,
            families: Vec::new(),
        }
    }
}