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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

macro_rules! shaah_mga_minutes_doc {
    ($minutes:expr) => {
        concat!(
            "Returns a *shaah zmanis* (solar hour) according to the opinion of
            the *Magen Avraham* (MGA) based on *alos* and *tzeis* being ",
            stringify!($minutes),
            " minutes before and after *hanetz* and *shkia*, respectively. This 
            calculation divides the day based on the opinion of the *Magen
            Avraham* (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_doc {
    ($minutes: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 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_doc {
    ($minutes: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 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_doc {
    ($minutes: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 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! mg_mga_minutes_doc {
    ($minutes:expr) => {
        concat!(
            "Returns the time of *mincha gedola* (the earliest time to pray
            *mincha* in the afternoon) according to the *Magen Avraham* with the
            day starting and ending ",
            stringify!($minutes),
            " minutes before and after *hanetz* and *shkia*, respectively. This 
            time is 6.5 *shaos zmaniyos* (solar hours) after *alos* based on the
            opinion of the MGA that the day is calculated from *alos* to
            *tzeis*. For more information on this see the documentation on
            [*mincha gedola*](crate::zmanim_calculator::mincha_gedola)."
        )
    };
}

macro_rules! slmk_mga_minutes_doc {
    ($minutes:expr) => {
        concat!(
            "Returns the time of *samuch lemincha ketana* (the time that eating
            or other activity can't begin prior to praying *mincha*) according
            to the *Magen Avraham* with the day starting and ending ",
            stringify!($minutes),
            " minutes before and after *hanetz* and *shkia*, respectively. This 
            time is half a *shaah zmanis* before
            *mincha ketana*, or 9 *shaos zmaniyos* (temporal hours) after *alos*
            based on the opinion of the MGA that the day is calculated from
            *alos* to *tzeis*. For more information on this see the
            documentation on [*samuch lemincha
            ketana*](crate::zmanim_calculator::samuch_lemincha_ketana)."
        )
    };
}

macro_rules! mk_mga_minutes_doc {
    ($minutes:expr) => {
        concat!(
            "Returns the time of *mincha ketana* according to the *Magen
            Avraham* with the day starting and ending ",
            stringify!($minutes),
            " minutes before and after *hanetz* and *shkia*, respectively. This 
            time is 9.5 *shaos zmaniyos* (solar
            hours) after *alos* based on the opinion of the MGA that the day is
            calculated from *alos* to *tzeis*. For more information on this see
            the documentation on [*mincha
            ketana*](crate::zmanim_calculator::mincha_ketana)."
        )
    };
}

macro_rules! plag_mga_minutes_doc {
    ($minutes:expr) => {
        concat!(
            "Returns the time of *plag hamincha* according to the *Magen
            Avraham* with the day starting and ending ",
            stringify!($minutes),
            " minutes before and after *hanetz* and *shkia*, respectively. This 
            time is 10.75 *shaos zmaniyos* (solar hours) after *alos* based on the
            opinion of the MGA that the day is calculated from *alos* to
            *tzeis*. For more information on this see the documentation on
            [*plag hamincha*](crate::zmanim_calculator::plag_hamincha)."
        )
    };
}

macro_rules! plag_mga_minutes_lechumra_doc {
    ($minutes:expr) => {
        concat!(
            "This method should only be used *lechumra* and returns the time of
            *plag hamincha* according to the *Magen Avraham* with the day
            starting and ending ",
            stringify!($minutes),
            " minutes before and after *hanetz* and *shkia*, respectively. This 
            time is 10.75 *shaos zmaniyos* (solar 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)."
        )
    };
}