Struct woddle::JobConfig

pub struct JobConfig {
    pub name: String,
    // some fields omitted
}

Configuration for a job

Fields

name: String

An arbitrary identifier used for logging

Implementations

impl JobConfig

Configuration for a single woddle job

Initialized with the name and sync_key of the job.

The name is an arbitrary identifier for the job. The sync_key is a unique identifier, which is used within the database.

For a job to be valid, either the interval, or the cron configuration need to be set.

If neither are set, the job_runner will exit with an Error.

pub fn new(name: &str, sync_key: &str) -> Self

Create a new job with an arbitrary name and a unique sync key

After creating a job, you need to set either interval, or cron for the job to be valid

pub fn interval(self, interval: Duration) -> Self

Sets the interval a job should be run at

pub fn cron(self, expression: &str) -> Self

Creates a cron schedule from the given Quartz cron expression

Example: "* 0 0 ? * * *"

Panics

Panics if the expression is not valid

Trait Implementations

impl Clone for JobConfig

fn clone(&self) -> JobConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for JobConfig

fn default() -> JobConfig

Returns the “default value” for a type.