Skip to main content

CronSchedule

Struct CronSchedule 

Source
pub struct CronSchedule { /* private fields */ }
Expand description

A validated cron_restart pattern together with the zone it is read in.

The croner and chrono-tz types are private: a cron dialect is a Flockfile grammar promise, and pinning it to a dependency’s public types would make that dependency’s next major version a breaking change to shep’s own config surface (IR-11).

Implementations§

Source§

impl CronSchedule

Source

pub fn parse( pattern: &str, timezone: Option<&str>, ) -> Result<Self, CronParseError>

Parses a cron_restart pattern and its optional cron_timezone.

§Errors
Source

pub fn next_after( &self, after: DateTime<Utc>, ) -> Result<Option<DateTime<Utc>>, CronScheduleError>

The first occurrence strictly after after, in UTC.

Returns None when the pattern has no further occurrence croner is willing to search for — a pattern like 0 0 30 2 * (30 February) that can never match.

A pattern that matches an hour repeated by a DST fall-back can return the same wall-clock occurrence twice across two successive calls — once for each pass through that hour. This is croner’s own standard local-time search semantics, not a defect this wrapper introduces or could suppress without also making the reverse case (a spring-forward hour that never occurs) harder to reason about.

§Errors
§Panics

Panics if converting after into zone’s local calendar lands outside the range chrono’s NaiveDateTime can represent — chrono panics rather than erroring in that case, and croner has no fallible entry point that avoids it (e.g. DateTime::<Utc>::MAX_UTC read in Pacific/Kiritimati, UTC+14, which pushes the local instant past the representable range). Unreachable from Utc::now(), which is the only after this crate’s own callers pass; documented rather than guarded because a guard would exist solely for an instant no caller can construct without going out of their way to do it.

Source

pub fn pattern(&self) -> &str

The pattern as written in the Flockfile.

Trait Implementations§

Source§

impl Clone for CronSchedule

Source§

fn clone(&self) -> CronSchedule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CronSchedule

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.