Struct ScheduledTask 

pub struct ScheduledTask {
    pub name: String,
    pub mode: TaskMode,
    pub kind: TaskKind,
    pub config: Value,
}

A task held in memory by the crate::Scheduler.

Use ScheduledTask::new / ScheduledTask::periodic for cron-based tasks and ScheduledTask::oneshot for tasks that run at a fixed point in time.

Examples

use zeph_scheduler::{ScheduledTask, TaskKind};

let task = ScheduledTask::new(
    "daily-cleanup",
    "0 3 * * *",           // every day at 03:00 UTC (5-field cron)
    TaskKind::MemoryCleanup,
    serde_json::Value::Null,
)
.expect("valid cron expression");

assert_eq!(task.task_mode_str(), "periodic");
assert!(task.cron_schedule().is_some());

Fields

name: String

Unique task name used as the primary key in the job store.

mode: TaskMode

Execution mode (periodic or one-shot).

kind: TaskKind

The category of work this task performs.

config: Value

Arbitrary JSON configuration forwarded to the TaskHandler at execution time.

Implementations

impl ScheduledTask

pub fn new( name: impl Into<String>, cron_expr: &str, kind: TaskKind, config: Value, ) -> Result<Self, SchedulerError>

Create a new periodic task from a cron expression string.

Errors

Returns SchedulerError::InvalidCron if the expression is not valid.

pub fn periodic( name: impl Into<String>, cron_expr: &str, kind: TaskKind, config: Value, ) -> Result<Self, SchedulerError>

Create a periodic task from a cron expression.

Errors

Returns SchedulerError::InvalidCron if the expression is not valid.

pub fn oneshot( name: impl Into<String>, run_at: DateTime<Utc>, kind: TaskKind, config: Value, ) -> Self

Create a one-shot task that runs at a specific point in time.

pub fn cron_schedule(&self) -> Option<&CronSchedule>

Returns the cron schedule if this is a periodic task.

pub fn cron_expr_string(&self) -> String

Returns the canonical 6-field cron expression string for DB persistence.

Returns an empty string for one-shot tasks, which do not have a cron schedule.

pub fn task_mode_str(&self) -> &'static str

Returns the task_mode string used for DB persistence.

Returns "periodic" or "oneshot".