Salah

Usage

Add the following to your Cargo.toml file under the [dependencies] section:

[dependencies]
salah = "0.4.2"

To get prayer times, use the PrayerSchedule struct passing in coordinates, date, and calculation parameters.

use salah::prelude::*;

let new_york_city = Coordinates::new(40.7128, -74.0059);
let date          = Utc.ymd(2019, 1, 25);
let params        = Configuration::with(Method::NorthAmerica, Madhab::Hanafi);
let prayers       = PrayerSchedule::new()
                      .on(date)
                      .for_location(new_york_city)
                      .with_configuration(params)
                      .calculate();

Initialization parameters

Coordinates

Create a Coordinates struct with the latitude and longitude for the location you want prayer times for.

let coordinates = Coordinates::new(40.7128, -74.0059);

Date

To avoid confusion with timezones the date parameter passed in should be an instance of Date<Utc>. The year, month, and day components need to be populated. All other components will be ignored.

let date = Utc.ymd(2019, 1, 25);

Configuration

The calculation of the prayer times requires certain pieces of information. These can configured using the Configuration struct, a builder for the underlaying Parameters struct. This struct can be initialized by passing one of the Method enum variants (see below for the available variants) along with the one of the Madhab enum variants. You can then further customize the calculation parameters if needed.

let params = Configuration::with(Method::NorthAmerica, Madhab::Hanafi);

Method

Madhab

HighLatitudeRule

Prayer Schedule

The PrayerSchedule struct is a builder for the the PrayerTimes struct. Once the calculate() method is invoked on it, a PrayerTime struct will be initialized and it will contain fields for all five prayer times, the time for sunrise, and for the Qiyam prayer.

The prayer time will be an instance of DateTime<Utc> and as such will refer to a fixed point in universal time. To display these times for the local timezone you will need to format them with the appropriate local time zone.

This struct provides convenience methods for the prayer times to ease their usage and display.

PrayerTime

Prayer

This is an enum and has variants for all prayers, including, sunrise and Qiyam. This is single method available for this type called, name(), that will return the name of the prayer transliterated into English.

Full Example

use salah::prelude::*;

let new_york_city = Coordinates::new(40.7128, -74.0059);
let date          = Utc.ymd(2019, 1, 25);
let params        = Configuration::with(Method::NorthAmerica, Madhab::Hanafi);
let prayers       = PrayerSchedule::new()
                        .on(date)
                        .for_location(new_york_city)
                        .with_configuration(params)
                        .calculate();

match prayers
{
    Ok(prayer) => {
        println!("{}: {}", Prayer::Fajr.name(), prayer.time(Prayer::Fajr).format("%-l:%M %p").to_string());
        println!("{}: {}", Prayer::Sunrise.name(), prayer.time(Prayer::Sunrise).format("%-l:%M %p").to_string());
        println!("{}: {}", Prayer::Dhuhr.name(), prayer.time(Prayer::Dhuhr).format("%-l:%M %p").to_string());
        println!("{}: {}", Prayer::Asr.name(), prayer.time(Prayer::Asr).format("%-l:%M %p").to_string());
        println!("{}: {}", Prayer::Maghrib.name(), prayer.time(Prayer::Maghrib).format("%-l:%M %p").to_string());
        println!("{}: {}", Prayer::Isha.name(), prayer.time(Prayer::Isha).format("%-l:%M %p").to_string());
        println!("{}: {}", Prayer::Qiyam.name(), prayer.time(Prayer::Qiyam).format("%-l:%M %p").to_string());
    },
    Err(error) => println!("Could not calculate prayer times: {}", error)
}

The output will be (in UTC):

Fajr: 10:53 AM
Sunrise: 12:12 PM
Dhuhr: 5:09 PM
Asr: 8:24 PM
Maghrib: 10:05 PM
Isha: 11:24 PM
Qiyam: 6:37 AM

Convenience Utilities

The PrayerTimes struct has functions for getting the current prayer and the next prayer. You can also get the time for a specified prayer, making it easier to dynamically show countdowns until the next prayer.

...
let prayers = PrayerSchedule::new()
                .on(date)
                .for_location(new_york_city)
                .with_configuration(params)
                .calculate();
let (hours, minutes) = prayers.current().time_remaining();

println!("Current: {} ({}:{})", prayers.current().name, hours, minutes);
println!("Next prayer is {} at {}.", prayers.next().name, prayers.time(prayer.next()).format("%-l:%M %p").to_string()));

Qibla Direction

Get the direction, in degrees from North, of the Qibla from a given set of coordinates.

let new_york_city   = Coordinates::new(40.7128, -74.0059);
let qibla_direction = Qibla::new(coordinates: new_york_city);

println!("Qiblah: {:?}", qibla_direction); //  Outputs: Qiblah: 58.4817

Contributing

Please see the CONTRIBUTING.md file for more information.

Code of Conduct

Our contributor code of conduct can be found in the code-of-conduct.md file.

Acknowledgement

This library is based on the Adhan library by Batoul Apps. All astronomical calculations are high precision equations directly from the book Astronomical Algorithms by Jean Meeus.

License

Salah is licensed under a three clause BSD License. It basically means: do whatever you want with it as long as the copyright in Salah sticks around, the conditions are not modified and the disclaimer is present. Furthermore you must not use the names of the authors to promote derivatives of the software without written consent.

The full license text can be found in the LICENSE file.