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

#[derive(Clone, Copy, Debug, PartialEq)]
/// WGS-84 GPS coordinates used to calculate sunset times for a [`LocalBadiDate`][`crate::LocalBadiDate`]
pub struct Coordinates {
    /// The latitude [-90...90.] in the WGS-84 coordinate system
    pub latitude: f64,
    /// The longitude [-180...180.] in the WGS-84 coordinate system
    pub longitude: f64,
}

/// Error returned for invalid [`Coordinates`]
#[derive(Debug)]
pub enum CoordinatesError {
    /// The latitude is not within -90...90. inclusive
    LatitudeInvalid,
    /// The longitude is not within -180...180. inclusive
    LongitudeInvalid,
}

impl CoordinatesError {
    /// Message to display for the [`CoordinatesError`]
    pub fn message(&self) -> String {
        match self {
            CoordinatesError::LatitudeInvalid => {
                "Latitude must be between -90.0 and 90.0 (inclusive)".to_string()
            }
            CoordinatesError::LongitudeInvalid => {
                "Longitude must be between -180.0 and 180.0 (inclusive)".to_string()
            }
        }
    }
}

impl Coordinates {
    /// Create a new set of WGS-84 GPS coordinates used in calculating sunset times
    /// (ensure these match the time zone being used!)
    pub fn new(latitude: f64, longitude: f64) -> Result<Self, CoordinatesError> {
        Ok(Self {
            latitude,
            longitude,
        })
    }
}