Struct Schedule

pub struct Schedule { /* private fields */ }

Represents a cron schedule pattern with its methods.

For cron schedule clarification and usage examples, please refer to the crate documentation.

Implementations

impl Schedule

pub fn new(pattern: impl Into<String>) -> Result<Self>

Parses and validates provided pattern and constructs Schedule instance.

Alternative way to construct Schedule is to use one of try_from or from_str methods .

Returns CronError in a case provided pattern is unparsable or has format errors.

pub fn upcoming<T: TimeZone>( &self, current: &DateTime<T>, ) -> Option<DateTime<T>>

Return time of the upcoming cron event, starting from the provided current value (inclusively).

If tz feature isn’t enabled, this method assumes that schedule timezone is the same as timezone of the provided current instance.

If tz feature is enabled and schedule uses timezone, then method calculates time of the upcoming event with respect to the schedule’s timezone:

• converts current into schedule timezone;
• calculates upcoming event time;
• converts obtained upcoming value back to the timezone of the current instance.

Returns None if there is no time for the upcoming event.

pub fn iter<Tz: TimeZone>( &self, current: &DateTime<Tz>, ) -> impl Iterator<Item = DateTime<Tz>>

Returns iterator of events starting from current (inclusively).

pub fn into_iter<Tz: TimeZone>( self, current: &DateTime<Tz>, ) -> impl Iterator<Item = DateTime<Tz>>

Consumes Schedule and returns iterator of events starting from current (inclusively).

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.

impl Display for Schedule

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

Formats the value using the given formatter.

impl From<&Schedule> for String

fn from(value: &Schedule) -> Self

Converts to this type from the input type.

impl From<Schedule> for String

fn from(value: Schedule) -> Self

Converts to this type from the input type.

impl FromStr for Schedule

type Err = CronError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for Schedule

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Schedule

fn eq(&self, other: &Schedule) -> 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 TryFrom<&String> for Schedule

type Error = CronError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for Schedule

type Error = CronError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Schedule

type Error = CronError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl Eq for Schedule

impl StructuralPartialEq for Schedule