Struct circadia::SunEvent

pub struct SunEvent {
    pub zenith: Zenith,
    pub event: Event,
}

Defines a sunset or sunrise at some angle above the horizon (the zenith).

Fields

zenith: Zenith

event: Event

Methods

impl SunEvent

pub const DAWN: SunEvent

pub const DUSK: SunEvent

pub const SUNRISE: SunEvent

pub const SUNSET: SunEvent

pub const fn new(zenith: Zenith, event: Event) -> Self

pub fn is_sunrise(self) -> bool

pub fn is_sunset(self) -> bool

Trait Implementations

impl Clone for SunEvent

fn clone(&self) -> SunEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SunEvent

impl Eq for SunEvent

impl Ord for SunEvent

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SunEvent> for SunEvent

fn eq(&self, other: &SunEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<SunEvent> for SunEvent

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Display for SunEvent

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

Formats the value using the given formatter.

impl Debug for SunEvent

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

Formats the value using the given formatter.

impl StructuralPartialEq for SunEvent

impl StructuralEq for SunEvent