Struct Schedule 

pub struct Schedule { /* private fields */ }

A schedule, as the database holds it.

What get_schedule and list_schedules return: the definition a ScheduleSpec wrote, and the state the scheduler keeps beside it — whether it is paused, and when it last fired.

The context is kept encoded, and decode_context decodes it on request: a schedule written by another SDK, or under another serializer, may hold a context this one cannot read, and listing it should not fail for that.

Implementations

impl Schedule

pub fn schedule_name(&self) -> &str

The schedule’s name, unique across every application sharing the database.

pub fn id(&self) -> &str

The id the database generated for the schedule. A schedule deleted and created again under the same name has a new one.

pub fn workflow(&self) -> &QualifiedWorkflowName

The workflow each tick enqueues.

pub fn schedule(&self) -> &str

The cron expression.

pub fn status(&self) -> ScheduleStatus

Whether the schedule is firing or paused.

pub fn context(&self) -> &str

The context each tick is called with, encoded.

pub fn decode_context<C: DeserializeOwned>(&self) -> Result<C>

The context each tick is called with, decoded as C.

Read with the configured Serializer. The column carries no tag, so a context written under another serializer — including one written before a CustomSerializer was configured — is read as if this one had written it: it fails to decode, or decodes to something else.

pub fn last_fired_at(&self) -> Option<SystemTime>

The tick the schedule last fired for, or None if it has not fired.

pub fn automatic_backfill(&self) -> bool

Whether an executor picking the schedule up first enqueues the ticks it missed.

pub fn cron_timezone(&self) -> Option<&str>

The IANA timezone the cron expression is read in, or None for UTC.

pub fn queue_name(&self) -> Option<&str>

The queue each tick is enqueued on, or None for the engine’s internal queue.

pub fn app_name(&self) -> Option<&str>

The application that owns the schedule, or None if it is unclaimed and every application sharing the database fires it.

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.

impl Eq for Schedule

impl PartialEq for Schedule

Two views are equal when they read the same row: which serializer reads the context is not part of the schedule.

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

Equality operator ==.

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

Inequality operator !=.