rust-zmanim 0.2.1

Rust Zmanim Library
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97

macro_rules! shaah_mga_minutes_zmanis_doc {
    ($minutes:expr, $fraction:expr) => {
        concat!(
            "Returns a *shaah zmanis* (temporal hour) according to the opinion
            of the *Magen Avraham* (MGA) based on *alos* and *tzeis* being ",
            stringify!($minutes),
            " minutes of [the GRA's *shaos
            zmaniyos*](crate::complex_zmanim_calendar::ComplexZmanimCalendar::shaah_zmanis_gra),
            or ",
            $fraction,
            " of the day before and after *hanetz* and *shkia*, respectively.
            This calculation divides the day based on the opinion of the MGA
            that the day runs from *alos* to *tzeis*. This day is split into 12
            equal parts with each part being a *shaah zmanis*."
        )
    };
}

macro_rules! szks_mga_minutes_zmanis_doc {
    ($minutes:expr, $fraction:expr) => {
        concat!(
            "Returns the latest *zman krias shema* (time to recite *Shema* in
            the morning) according to the opinion of the *Magen Avraham* (MGA)
            based on *alos* and *tzeis* being ",
            stringify!($minutes),
            " minutes of [the GRA's *shaos
            zmaniyos*](crate::complex_zmanim_calendar::ComplexZmanimCalendar::shaah_zmanis_gra),
            or ",
            $fraction,
            " of the day before and after *hanetz* and *shkia*, respectively.
            This time is 3 *shaos zmaniyos* (temporal hours) after *alos* based on
            the opinion of the MGA that the day is calculated from *alos* to
            *tzeis*."
        )
    };
}

macro_rules! szt_mga_minutes_zmanis_doc {
    ($minutes:expr, $fraction:expr) => {
        concat!(
            "Returns the latest *zman tefila* (time to recite the morning
            prayers) according to the opinion of the *Magen Avraham* (MGA)
            based on *alos* and *tzeis* being ",
            stringify!($minutes),
            " minutes of [the GRA's *shaos
            zmaniyos*](crate::complex_zmanim_calendar::ComplexZmanimCalendar::shaah_zmanis_gra),
            or ",
            $fraction,
            " of the day before and after *hanetz* and *shkia*, respectively.
            This time is 4 *shaos zmaniyos* (temporal hours) after *alos* based on
            the opinion of the MGA that the day is calculated from *alos* to
            *tzeis*."
        )
    };
}

macro_rules! sz_biur_chametz_mga_minutes_zmanis_doc {
    ($minutes:expr, $fraction:expr) => {
        concat!(
            "Returns the latest time for burning *chametz* on *Erev Pesach*
            according to the opinion of the *Magen Avraham* (MGA)
            based on *alos* and *tzeis* being ",
            stringify!($minutes),
            " minutes of [the GRA's *shaos
            zmaniyos*](crate::complex_zmanim_calendar::ComplexZmanimCalendar::shaah_zmanis_gra),
            or ",
            $fraction,
            " of the day before and after *hanetz* and *shkia*, respectively.
            This time is 5 *shaos zmaniyos* (temporal hours) after *alos* based on
            the opinion of the MGA that the day is calculated from *alos* to
            *tzeis*. Since this library does not implement a calendar, this
            method will return the *zman* any day of the year."
        )
    };
}

macro_rules! plag_mga_minutes_zmanis_lechumra_doc {
    ($minutes:expr, $fraction:expr) => {
        concat!(
            "This method should only be used *lechumra* and returns the time of
            *plag hamincha* according to the opinion of the *Magen Avraham*
            (MGA) based on *alos* and *tzeis* being ",
            stringify!($minutes),
            " minutes of [the GRA's *shaos
            zmaniyos*](crate::complex_zmanim_calendar::ComplexZmanimCalendar::shaah_zmanis_gra),
            or ",
            $fraction,
            " of the day before and after *hanetz* and *shkia*, respectively.
            This time is 10.75 *shaos zmaniyos* (temporal hours) after *alos*
            based on the opinion of the MGA that the day is calculated from
            *alos* to *tzeis*. Since *plag* by this calculation can occur after
            sunset, it should only be used *lechumra*. For more information on
            this see the documentation on [*plag
            hamincha*](crate::zmanim_calculator::plag_hamincha)."
        )
    };
}