Struct tasklet::TaskBuilder

pub struct TaskBuilder<'a, T> where
    T: TimeZone,  { /* fields omitted */ }

Task builder function.

Used to generate/build a TaskStep instance.

Implementations

impl<'a, T> TaskBuilder<'a, T> where
    T: TimeZone, 

pub fn new(timezone: T) -> TaskBuilder<'a, T>

Create a new TaskBuilder instance.

Arguments

• timezone - A valid timezone for the generated Task.

Examples

let _task_builder = TaskBuilder::new(chrono::Utc);

pub fn description(mut self: Self, description: &str) -> TaskBuilder<'a, T>

Set the optional description of the generated Task.

Arguments

• description - A descripotion for the task.

let _task = TaskBuilder::new(chrono::Local).every("* * * * * * *").description("Description").build();

pub fn every(mut self: Self, expression: &str) -> TaskBuilder<'a, T>

Set the execution schedule of the task to be generated.

Arguments

• expression - A valid cron expression.

Examples

let _task = TaskBuilder::new(chrono::Local).every("* * * * * * *").build();

pub fn repeat(mut self: Self, repeat: usize) -> TaskBuilder<'a, T>

Set the max repeats for the generated Task.

Arguments

• repeats - The max amount of repeats.

Examples

let _task = TaskBuilder::new(chrono::Local).repeat(5);

pub fn add_step<F>(
    mut self: Self,
    description: Option<&str>,
    function: F
) -> TaskBuilder<'a, T> where
    F: FnMut() -> Result<(), ()> + 'a, 

Add a new step for the generated task.

Arguments

• description - An optional description for the task's step.
• function - The executable body of the task's step.

Examples

let _task = TaskBuilder::new(chrono::Local).add_step(None, || Ok(()));
let _task = TaskBuilder::new(chrono::Utc).add_step(Some("A step that fails."), || Err(()));

pub fn build(self) -> Task<'a, T>

Build a new Task instance from the current configuration.

Examples

let mut _task = TaskBuilder::new(chrono::Utc).build();