jyotish 1.0.0

Jyotish — astronomical computation engine for planetary positions, calendar systems, and celestial event prediction
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
75
76

use thiserror::Error;

/// Errors that can occur during jyotish computations.
///
/// # Examples
///
/// ```
/// # use jyotish::*;
/// let err = JyotishError::InvalidParameter("negative longitude".into());
/// assert!(err.to_string().contains("negative longitude"));
///
/// let err = JyotishError::DateError("invalid Julian Day".into());
/// assert!(err.to_string().contains("invalid Julian Day"));
/// ```
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum JyotishError {
    /// An invalid parameter was provided to a computation.
    #[error("invalid parameter: {0}")]
    InvalidParameter(String),

    /// A mathematical computation failed.
    #[error("math error: {0}")]
    MathError(String),

    /// A date/time conversion or validation failed.
    #[error("date error: {0}")]
    DateError(String),

    /// An ephemeris lookup or interpolation failed.
    #[error("ephemeris error: {0}")]
    EphemerisError(String),

    /// An I/O operation failed.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
}

/// A convenience type alias for `Result<T, JyotishError>`.
pub type Result<T> = std::result::Result<T, JyotishError>;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn error_display() {
        let e = JyotishError::InvalidParameter("negative longitude".into());
        assert!(e.to_string().contains("negative longitude"));
    }

    #[test]
    fn error_math() {
        let e = JyotishError::MathError("division by zero".into());
        assert!(e.to_string().contains("division by zero"));
    }

    #[test]
    fn error_date() {
        let e = JyotishError::DateError("invalid Julian Day".into());
        assert!(e.to_string().contains("invalid Julian Day"));
    }

    #[test]
    fn error_ephemeris() {
        let e = JyotishError::EphemerisError("missing data".into());
        assert!(e.to_string().contains("missing data"));
    }

    #[test]
    fn error_io() {
        let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "file missing");
        let e = JyotishError::from(io_err);
        assert!(e.to_string().contains("file missing"));
    }
}