Skip to main content

ScheduledRunCtx

Struct ScheduledRunCtx 

Source
pub struct ScheduledRunCtx {
    pub schedule_id: String,
    pub scheduled_at_ms: u64,
    pub run_count: u64,
    pub is_catchup: bool,
    pub tenant_id: Option<String>,
    pub site_id: Option<String>,
}
Expand description

Context supplied to a single invocation of ScheduledPlugin::run.

Plain-data only — no framework types. The host populates this from its own clock and scheduler state; the plugin reads it to decide how to behave on catch-up runs, to emit tracing, etc.

Fields§

§schedule_id: String

The Schedule::id being invoked. The plugin dispatches on this when it owns more than one schedule.

§scheduled_at_ms: u64

Wall-clock time the scheduler decided to fire this run, milliseconds since Unix epoch. May differ from “now” when the run is a catch-up under MissedRunPolicy::RunAll.

§run_count: u64

Monotonic run counter since the scheduler started. Lets the plugin detect “first run after restart” (run_count == 1) without storing its own state.

§is_catchup: bool

true if this run is catching up for a tick missed while the host was down. false for normal on-time runs. Lets idempotent jobs skip expensive work on catch-up.

§tenant_id: Option<String>

Tenant id the run is scoped to, if the plugin is installed under a tenant. Matches the tenant_id on crate::middleware::RequestContext for consistency.

§site_id: Option<String>

Site id the run is scoped to, if the plugin is installed under a site.

Trait Implementations§

Source§

impl Clone for ScheduledRunCtx

Source§

fn clone(&self) -> ScheduledRunCtx

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 ScheduledRunCtx

Source§

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

Formats the value using the given formatter. Read more

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, 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.