Enum SunriseResult 

pub enum SunriseResult<T = DateTime<Utc>> {
    RegularDay {
        sunrise: T,
        transit: T,
        sunset: T,
    },
    AllDay {
        transit: T,
    },
    AllNight {
        transit: T,
    },
}

Result of sunrise/sunset calculations for a given day.

Solar events can vary significantly based on location and time of year, especially at extreme latitudes where polar days and nights occur.

Variants

RegularDay

Regular day with distinct sunrise, transit (noon), and sunset times

Fields

sunrise: T

Time of sunrise

transit: T

Time of solar transit (when sun crosses meridian, solar noon)

sunset: T

Time of sunset

AllDay

Polar day - sun remains above the specified horizon all day

Fields

transit: T

Time of solar transit (closest approach to zenith)

AllNight

Polar night - sun remains below the specified horizon all day

Fields

transit: T

Time of solar transit (when sun is highest, though still below horizon)

Implementations

impl<T> SunriseResult<T>

pub const fn transit(&self) -> &T

Gets the transit time (solar noon) for any sunrise result.

pub const fn is_regular_day(&self) -> bool

Checks if this represents a regular day with sunrise and sunset.

pub const fn is_polar_day(&self) -> bool

Checks if this represents a polar day (sun never sets).

pub const fn is_polar_night(&self) -> bool

Checks if this represents a polar night (sun never rises).

pub const fn sunrise(&self) -> Option<&T>

Gets sunrise time if this is a regular day.

pub const fn sunset(&self) -> Option<&T>

Gets sunset time if this is a regular day.

Trait Implementations

impl<T: Clone> Clone for SunriseResult<T>

fn clone(&self) -> SunriseResult<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for SunriseResult<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for SunriseResult<T>

fn eq(&self, other: &SunriseResult<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for SunriseResult<T>

impl<T> StructuralPartialEq for SunriseResult<T>