Struct cronchik::CronSchedule

pub struct CronSchedule { /* private fields */ }

Cron schedule.

Size

184 bytes.

This is relatively big struct, which might be better suited to be allocated on heap. So if you expect to move it a lot, prefer heap. Alternatively you could store cron expression as String and parse it each time.

Usage

use cronchik::CronSchedule;

let schedule = CronSchedule::parse_str("5 * * * *").unwrap();
assert_eq!(core::mem::size_of::<CronSchedule>(), 184);
let display = format!("{}", schedule);
assert_eq!(display, "5 * * * *");

Implementations

impl CronSchedule

pub fn parse_str(text: &str) -> Result<Self, ParseError>

Parses cron expression from string.

pub fn days_of_month(&self) -> &[DayOfMonth]

Returns ordered list of scheduled days in month to run at.

pub fn minutes(&self) -> &[Minute]

Returns ordered list of scheduled minutes to run at.

pub fn hours(&self) -> &[Hour]

Returns ordered list of scheduled hours to run at.

pub fn days_of_week(&self) -> &[Day]

Returns ordered list of scheduled days in week to run at.

pub fn months(&self) -> &[Month]

Returns ordered list of scheduled months to run at.

pub fn next_time_from(&self, time: OffsetDateTime) -> OffsetDateTime

Returns next point if time, after time, accordingly to the schedule.

Available with time feature

pub fn next_time_from_now(&self) -> OffsetDateTime

Returns next point if time, after current time in UTC timezone.

Available with time feature

Trait Implementations

impl Clone for CronSchedule

fn clone(&self) -> CronSchedule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CronSchedule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CronSchedule

fn deserialize<D: Deserializer<'de>>(des: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for CronSchedule

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

Formats the value using the given formatter.

impl PartialEq<CronSchedule> for CronSchedule

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CronSchedule

fn serialize<SER: Serializer>(&self, ser: SER) -> Result<SER::Ok, SER::Error>

Serialize this value into the given Serde serializer.

impl Eq for CronSchedule

impl StructuralEq for CronSchedule

impl StructuralPartialEq for CronSchedule