Struct CronContext 

#[non_exhaustive]
pub struct CronContext {
    pub run_id: Uuid,
    pub cron_name: String,
    pub scheduled_time: DateTime<Utc>,
    pub execution_time: DateTime<Utc>,
    pub timezone: String,
    pub is_catch_up: bool,
    pub auth: AuthContext,
    /* private fields */
}

Context available to cron handlers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

run_id: Uuid

cron_name: String

scheduled_time: DateTime<Utc>

execution_time: DateTime<Utc>

timezone: String

is_catch_up: bool

auth: AuthContext

Implementations

impl CronContext

pub fn new( run_id: Uuid, cron_name: impl Into<String>, scheduled_time: DateTime<Utc>, timezone: String, is_catch_up: bool, db_pool: PgPool, http_client: CircuitBreakerClient, ) -> Self

Create a new cron context.

pub fn with_kv(self, kv: Arc<dyn KvHandle>) -> Self

Attach a KV store handle. Called by the runtime before handing the context to the handler.

pub fn kv(&self) -> Result<&dyn KvHandle>

Access the KV store.

pub fn with_env_provider(self, provider: Arc<dyn EnvProvider>) -> Self

Set environment provider.

pub fn db(&self) -> ForgeDb

pub fn db_conn(&self) -> DbConn<'_>

Get a DbConn for use in shared helper functions.

pub async fn conn(&self) -> Result<ForgeConn<'static>>

Acquire a connection compatible with sqlx compile-time checked macros.

pub fn http(&self) -> HttpClient

pub fn raw_http(&self) -> &Client

pub fn set_http_timeout(&mut self, timeout: Option<Duration>)

pub fn delay(&self) -> Duration

Get the delay between scheduled and actual execution time.

pub fn is_late(&self) -> bool

Check if the cron is running late (more than 1 minute delay).

pub fn with_auth(self, auth: AuthContext) -> Self

Set authentication context.

pub fn trace_id(&self) -> String

Get the trace ID for this cron execution.

Returns the trace ID if OpenTelemetry is configured, otherwise returns the run_id.

pub fn span(&self) -> &Span

Get the parent span for trace propagation.

Use this to create child spans within cron handlers.

Trait Implementations

impl EnvAccess for CronContext

fn env_provider(&self) -> &dyn EnvProvider

fn env(&self, key: &str) -> Option<String>

fn env_or(&self, key: &str, default: &str) -> String

fn env_require(&self, key: &str) -> Result<String>

fn env_parse<T: FromStr>(&self, key: &str) -> Result<T>

where T::Err: Display,

fn env_parse_or<T: FromStr>(&self, key: &str, default: T) -> Result<T>

where T::Err: Display,

Returns the default when unset; errors only if the variable is set but unparseable.

fn env_contains(&self, key: &str) -> bool

impl HandlerContext for CronContext

fn db(&self) -> ForgeDb

Database handle with automatic db.query tracing spans.

fn db_conn(&self) -> DbConn<'_>

Unified connection handle for shared helper functions.