Skip to main content

RecurringJob

Struct RecurringJob 

Source
pub struct RecurringJob {
    pub id: String,
    pub cron: String,
    pub method: String,
    pub payload: Value,
    pub queue: String,
    pub next_run_at: DateTime<Utc>,
    pub last_run_at: Option<DateTime<Utc>>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub enabled: bool,
}
Expand description

A cron-scheduled job template.

Fields§

§id: String

Stable recurring-job id (caller-chosen, e.g. "daily-report").

§cron: String

Cron expression in the cron crate’s 6/7-field format (sec min hour day month dow [year]).

§method: String

Method name registered with the worker registry.

§payload: Value

JSON payload passed to the worker on each firing.

§queue: String

Queue the materialized jobs land in.

§next_run_at: DateTime<Utc>

Next firing time (computed from cron).

§last_run_at: Option<DateTime<Utc>>

When the template last produced a job, or None if never fired.

§created_at: DateTime<Utc>

When the template was first created.

§updated_at: DateTime<Utc>

When the template was last mutated.

§enabled: bool

Disabled templates are ignored by the poller.

Implementations§

Source§

impl RecurringJob

Source

pub fn new( id: impl Into<String>, cron: impl Into<String>, method: impl Into<String>, payload: JsonValue, queue: impl Into<String>, ) -> Result<Self>

Creates a new recurring-job template. Parses cron and computes next_run_at from now. Returns a validation error if the expression is invalid or has no future occurrences.

Source

pub fn advance(&mut self, from: DateTime<Utc>) -> Result<()>

Recomputes next_run_at to the next occurrence strictly after from, updating updated_at in the process. Returns an error if the stored cron expression is no longer parseable or has no future occurrence (the latter shouldn’t happen for sane expressions).

Source

pub fn schedule(&self) -> Result<Schedule>

Parses the stored cron expression. Useful when a caller needs more than just “next firing” (e.g. listing upcoming runs).

Trait Implementations§

Source§

impl Clone for RecurringJob

Source§

fn clone(&self) -> RecurringJob

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecurringJob

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RecurringJob

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for RecurringJob

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for RecurringJob

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RecurringJob

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,