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 methods.

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

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

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

Returns None if there is no upcoming event’s time.

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 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 Ord for Schedule

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for Schedule

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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