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

// Degrees
macro_rules! alos_degrees_basedon_doc {
    ($degrees:expr, $minutes:expr) => {
        concat!(
            "Returns *alos* (dawn) calculated when the sun is ",
            stringify!($degrees),
            "° below the eastern geometric horizon before sunrise. This
            calculation is based on the position of the sun ",
            stringify!($minutes),
            " minutes before sunrise in Jerusalem around the equinox / equilux,
            which calculates to ",
            stringify!($degrees),
            "° below geometric zenith."
        )
    };
}

macro_rules! alos_degrees_basedon_lechumra_doc {
    ($degrees:expr, $minutes:expr) => {
        concat!(
            "This method should only be used *lechumra* and returns *alos*
            (dawn) calculated when the sun is ",
            stringify!($degrees),
            "° below the eastern geometric horizon before sunrise. This
            calculation is based on the position of the sun ",
            stringify!($minutes),
            " minutes before sunrise in Jerusalem around the equinox / equilux,
            which calculates to ",
            stringify!($degrees),
            "° below geometric zenith. Since this time is extremely early,
            it should only be used *lechumra*, such as not eating after
            this time on a fast day, and not as the start time for *mitzvos*
            that can only be performed during the day."
        )
    };
}

macro_rules! alos_degrees_doc {
    ($degrees:expr) => {
        concat!(
            "Returns *alos* (dawn) calculated when the sun is ",
            stringify!($degrees),
            "° below the eastern geometric horizon before sunrise."
        )
    };
}

// Minutes
macro_rules! alos_minutes_basedon_doc {
    ($minutes:expr, $mil_len:expr) => {
        concat!(
            "Returns *alos* (dawn) calculated as ",
            stringify!($minutes),
            " minutes before sunrise. This time is based on the time to walk the
            distance of 4 *mil* at ",
            stringify!($mil_len),
            " minutes per *mil*. Time-based offset calculations for *alos* are
            based on the opinion of the *Rishonim* who stated that the time of
            the *Neshef* (twilight between dawn and sunrise) does not vary by
            the time of year or location but depends on the time it takes to
            walk the distance of 4 *mil*."
        )
    };
}

// Minutes zmaniyos
macro_rules! alos_minutes_zmanis_basedon_doc {
    ($minutes:expr, $mil_len:expr, $fraction:expr) => {
        concat!(
            "Returns *alos* (dawn) calculated as ",
            stringify!($minutes),
            " minutes of [the GRA's *shaos
            zmaniyos*](crate::complex_zmanim_calendar::ComplexZmanimCalendar::shaah_zmanis_gra),
            or ",
            $fraction,
            " of the day before sunrise. This time is based on the time to walk the
            distance of 4 *mil* at ",
            stringify!($mil_len),
            " minutes per *mil*."
        )
    };
}