islam 2.0.0

Islamic library for Rust
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

<div align="center">
<h1>islam</h1>

<a href="https://github.com/azzamsa/islam/workflows/ci.yml">
<img src="https://github.com/azzamsa/islam/workflows/ci/badge.svg">
</a>
<a href="https://crates.io/crates/islam">
<img src="https://img.shields.io/crates/v/islam.svg">
</a>
<a href="https://docs.rs/islam/">
<img src="https://docs.rs/islam/badge.svg">
</a>

<p></p>

</div>

---

_islam_ is an Islamic library for Rust.
It is a direct port of [PyIslam](https://github.com/abougouffa/pyIslam) with a slight change in the API part.

## Why?

I have always got `panic!` working with [salah](https://github.com/insha/salah).
Previously, I have good experience with [PyIslam](https://github.com/abougouffa/pyIslam).
In my case, it is very precise and has a simple algorithm. Nowadays, I work a lot with Rust.
So here it is, `islam` is born!

## Features

- Hijri date
- Prayer times

## Usage

### Getting Prayer Times

```rust
// https://www.mapcoordinates.net/en
let jakarta_city = Location::new(6.182_34_f32, 106.842_87_f32);
let today = NaiveDateTime::now_local()?.date();
let config = Config::new().with(Method::Singapore, Madhab::Shafi);
let prayer_times = PrayerSchedule::new(jakarta_city)?
    .on(today)
    .with_config(config)
    .calculate()?;
```

First, you need to specify `Location` with `latitude`, and `longitude` as parameters.
Then choose a calculation method such `Singapore`. Other methods available [in the docs](https://docs.rs/islam/latest/islam/pray/method/enum.Method.html#variants).
There are also `madhab` configurations that you [can choose from](https://docs.rs/islam/latest/islam/pray/madhab/enum.Madhab.html#variants).

### Getting Hijri Date

```rust
let from_gregorian = HijriDate::from_gregorian(date!(2021 - 4 - 9), 0);
println!(
    "From gregorian: {}-{}-{}",
    from_gregorian.year, from_gregorian.month, from_gregorian.day,
);
```

`from_gregorian` accepts `Date` and `correction value` as parameters.

## More Examples

To learn more, see other [examples](examples/).

## Acknowledgement

The calculation part of this library is a direct port of
[PyIslam](https://github.com/abougouffa/pyIslam) with a slight change in the API
part. The API took inspiration from [salah](https://github.com/insha/salah)