pub struct EclipseEngine<B> { /* private fields */ }Expand description
Searches for global/geocentric eclipses over a chosen EphemerisBackend.
Backed by the packaged data, results are valid only within the
1900-01-01..2100-01-01 window (see crate); out-of-window requests fail
closed with EclipseError::OutOfWindow.
Implementations§
Source§impl<B: EphemerisBackend> EclipseEngine<B>
impl<B: EphemerisBackend> EclipseEngine<B>
Sourcepub fn eclipses_in_range(
&self,
start: Instant,
end: Instant,
filter: EclipseFilter,
) -> Result<Vec<Eclipse>, EclipseError>
pub fn eclipses_in_range( &self, start: Instant, end: Instant, filter: EclipseFilter, ) -> Result<Vec<Eclipse>, EclipseError>
Returns every eclipse admitted by filter with greatest eclipse in
[start, end], in chronological order. Fails closed if either bound is
outside the supported window.
Sourcepub fn next_eclipse(
&self,
after: Instant,
filter: EclipseFilter,
) -> Result<Option<Eclipse>, EclipseError>
pub fn next_eclipse( &self, after: Instant, filter: EclipseFilter, ) -> Result<Option<Eclipse>, EclipseError>
Returns the first eclipse admitted by filter whose greatest eclipse is
strictly after after, or None if none remains before the window end.
Sourcepub fn previous_eclipse(
&self,
before: Instant,
filter: EclipseFilter,
) -> Result<Option<Eclipse>, EclipseError>
pub fn previous_eclipse( &self, before: Instant, filter: EclipseFilter, ) -> Result<Option<Eclipse>, EclipseError>
Returns the last eclipse admitted by filter whose greatest eclipse is
strictly before before, or None if none exists after the window start.
Auto Trait Implementations§
impl<B> Freeze for EclipseEngine<B>where
B: Freeze,
impl<B> RefUnwindSafe for EclipseEngine<B>where
B: RefUnwindSafe,
impl<B> Send for EclipseEngine<B>where
B: Send,
impl<B> Sync for EclipseEngine<B>where
B: Sync,
impl<B> Unpin for EclipseEngine<B>where
B: Unpin,
impl<B> UnsafeUnpin for EclipseEngine<B>where
B: UnsafeUnpin,
impl<B> UnwindSafe for EclipseEngine<B>where
B: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more