~azzamsa/islam

Islamic library for Rust
docs: update contributing
refactor: remove unused upstream code

clone

read-only
https://git.sr.ht/~azzamsa/islam
read/write
git@git.sr.ht:~azzamsa/islam

You can also use your local clone with git send-email.

islam


islam is an Islamic library for Rust. It is a direct port of PyIslam with a slight change in the API part.

#Why?

I have always got panic! working with salah. Previously, I have good experience with 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

// GMT+7
let timezone = 7;
// https://www.mapcoordinates.net/en
let jakarta_city = Location::new(-6.18233995_f32, 106.84287154_f32, timezone);
let date = Local.ymd(2021, 4, 9);
let config = Config::new().with(Method::Singapore, Madhab::Shafi);
let prayer_times = Prayer::new(jakarta_city)
    .on(date)
    .with_config(config)
    .calculate();

First, you need to specify Location with latitude, longitude, timezone as parameters. Then choose a calculation method such Singapore. Other methods available in the docs. There are also madhab configurations that you can choose from.

#Getting Hijri Date

let from_gregorian = HijriDate::from_gregorian(Local.ymd(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.

#Contributing

Please send patches and questions to my public-inbox mailing list.

Bugs and Todo here: https://todo.sr.ht/~azzamsa/islam

#Acknowledgement

The calculation part of this library is a direct port of PyIslam with a slight change in the API part. The API took inspiration from salah