starfall 0.1.0

Astronomical sciences, from the galaxy to the moon, for my Hornvale project.
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

use crate::astronomy::star::error::Error as StarError;

/// Close binary star-related errors.
#[derive(Clone, Copy, Debug, Eq, Error, Hash, PartialEq)]
pub enum Error {
  /// Star Error.
  #[error("an error occurred in the star ({0})")]
  StarError(#[from] StarError),
  /// Lower than MINIMUM_SEPARATION.
  #[error("the stars are too close together to be stable")]
  BinaryStarsTooCloseForComfort,
  /// The habitable zone is contained within the forbidden zone.
  #[error("the stars' habitable zone is contained within their forbidden zone")]
  HabitableZoneContainedWithinForbiddenZone,
  /// The habitable zone isn't sufficiently far from the host stars.
  #[error("the stars' habitable zone is too close to the host stars")]
  HabitableZoneContainedWithinDangerZone,
  /// No habitable conditions found anywhere in StarSubsystem.
  #[error("the stars do not have a habitable zone")]
  NoHabitableZoneFound,
  /// An unknown error occurred.
  #[error("an unknown error occurred")]
  UnknownError,
}

#[cfg(test)]
pub mod test {

  use super::*;
  use crate::test::*;

  #[named]
  #[test]
  pub fn test_errors() {
    init();
    trace_enter!();
    let mut error = Error::BinaryStarsTooCloseForComfort;
    print_var!(error);
    error = Error::HabitableZoneContainedWithinForbiddenZone;
    print_var!(error);
    error = Error::HabitableZoneContainedWithinDangerZone;
    print_var!(error);
    error = Error::NoHabitableZoneFound;
    print_var!(error);
    error = Error::UnknownError;
    print_var!(error);
    error = Error::StarError(StarError::UnknownError);
    print_var!(error);
    error = StarError::UnknownError.into();
    print_var!(error);
    trace_exit!();
  }
}