Struct SchedulePolicy 

pub struct SchedulePolicy {
    pub catchup: CatchupPolicy,
    pub catchup_max: u32,
    pub catchup_window_secs: u32,
    pub overlap: OverlapPolicy,
    pub timezone: Tz,
}

Catch-up, overlap and timezone policy of a schedule.

Examples

use chrono_tz::Tz;
use ironflow_store::entities::{CatchupPolicy, OverlapPolicy, SchedulePolicy};

let policy = SchedulePolicy {
    catchup: CatchupPolicy::All,
    overlap: OverlapPolicy::Skip,
    timezone: Tz::Europe__Paris,
    ..SchedulePolicy::default()
};
assert!(policy.validate().is_ok());

let invalid = SchedulePolicy { catchup_max: 0, ..SchedulePolicy::default() };
assert!(invalid.validate().is_err());

Fields

catchup: CatchupPolicy

What to do with missed occurrences.

catchup_max: u32

Most runs created to catch up under CatchupPolicy::All, between MIN_CATCHUP_MAX and MAX_CATCHUP_MAX.

catchup_window_secs: u32

How far back, in seconds, a missed occurrence is still caught up, between MIN_CATCHUP_WINDOW_SECS and MAX_CATCHUP_WINDOW_SECS.

overlap: OverlapPolicy

What to do when a run of the schedule is still active.

timezone: Tz

IANA timezone the cron expression is evaluated in, e.g. Europe/Paris.

Implementations

impl SchedulePolicy

pub fn validate(&self) -> Result<(), String>

Check the numeric bounds of the policy. The timezone is checked where the timezone database is available (API and engine).

Errors

Returns a message naming the field out of its range.

Examples

use ironflow_store::entities::SchedulePolicy;

let policy = SchedulePolicy { catchup_window_secs: 10, ..SchedulePolicy::default() };
assert_eq!(
    policy.validate().unwrap_err(),
    "catchup_window_secs must be between 60 and 2592000",
);

Trait Implementations

impl Clone for SchedulePolicy

fn clone(&self) -> SchedulePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchedulePolicy

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

Formats the value using the given formatter.

impl Default for SchedulePolicy

fn default() -> SchedulePolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchedulePolicy

fn deserialize<__D>( __deserializer: __D, ) -> Result<SchedulePolicy, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SchedulePolicy

impl PartialEq for SchedulePolicy

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SchedulePolicy

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SchedulePolicy