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

//! # heca-lib
//! heca-lib is a blazingly fast Hebrew calender library. It's the backend behind the heca program.
//!
//! # Usage:
//!
//! 1. Add to Cargo.toml:
//!
//!```toml
//!     [dependencies]
//!     heca-lib = "1.3"
//!```
//!
//! 2. Add the following to your crate root:
//!
//! ```
//! extern crate heca_lib;
//!
//! ```
//! 3. Import the types:
//!
//!```
//!use heca_lib::prelude::*;
//!use heca_lib::*;
//!```
//!
//! # Overview:
//!
//! ## Convert:
//!
//! This library can convert from Hebrew to Gregorian dates and back. You can get a HebrewDate either from a known Hebrew date or from a Gregorian date:
//!
//! ```
//!
//! use std::num::NonZeroI8;
//! use std::convert::TryInto;
//!
//! use chrono::Utc;
//! use chrono::offset::TimeZone;
//! use heca_lib::prelude::*;
//! use heca_lib::HebrewDate;
//!
//!
//! let hebrew_date: HebrewDate = Utc.ymd(2018,9,10).and_hms(17,59,59).try_into()?;
//! assert_eq!(hebrew_date,HebrewDate::from_ymd(5779,HebrewMonth::Tishrei,NonZeroI8::new(1).unwrap())?);
//! # Ok::<(),ConversionError>(())
//!
//!```
//!
//!You can then get back a Gregorian date from this Hebrew Date.
//!
//!```
//!
//! use std::num::NonZeroI8;
//! use std::convert::TryInto;
//!
//! use chrono::prelude::*;
//! use heca_lib::{HebrewDate};
//! use heca_lib::prelude::*;
//!
//! let eng_day: DateTime<Utc> = HebrewDate::from_ymd(5779,HebrewMonth::Tishrei,NonZeroI8::new(10).unwrap())?.into();
//! assert_eq!(eng_day, Utc.ymd(2018, 9,18).and_hms(18,00,00));
//! # Ok::<(),ConversionError>(())
//!
//!```
//!
//! ## Get Information on the Hebrew Year
//!
//! This library can also list the major Jewish holidays and Torah readings in a given year (for
//! both Israel and the Diaspora):
//!
//!```
//!
//!use std::num::NonZeroI8;
//!
//!use heca_lib::{HebrewYear,HebrewDate};
//!use heca_lib::prelude::*;
//!
//!assert_eq!(HebrewYear::new(5779)?.get_holidays(Location::Chul, &[TorahReadingType::Shabbos])[0].name(), TorahReading::Shabbos(Parsha::Vayelech));
//!assert_eq!(HebrewYear::new(5779)?.get_holidays(Location::Chul, &[TorahReadingType::SpecialParsha]).iter().find(|x| x.name() == TorahReading::SpecialParsha(SpecialParsha::Zachor)).unwrap().day(),HebrewDate::from_ymd(5779,HebrewMonth::Adar2,NonZeroI8::new(9).unwrap())?);
//!# Ok::<(),ConversionError>(())
//!
//!```
//!
//!
//!# Notes:
//!
//!This library won't work for years before 3764 (4).

#[macro_use]
extern crate lazy_static;
mod convert;
mod holidays;
pub mod prelude;
#[doc(inline)]
pub use convert::HebrewDate;
#[doc(inline)]
pub use convert::HebrewYear;