Struct ScriptHandle 

pub struct ScriptHandle<P> { /* private fields */ }

A typed handle for scheduling a script with specific parameters.

Created by the #[chronon::script] macro. The attribute turns the annotated function into a handle factory (fn nightly_cleanup() -> ScriptHandle<…>) and moves the body to an internal __*_impl entry point used by the executor.

After building a Job, set crate::ScheduleKind / cron fields and upsert via CoordinatorService (Mode 1–2) or RemoteCoordinatorClient (Mode 3).

Examples

Build a default Job from the macro-generated handle, then upsert it:

use chronon_core::{Job, ScriptHandle};
use serde::Serialize;

#[derive(Serialize)]
struct NightlyCleanupParams {
    retention_days: u32,
}

let handle = ScriptHandle::<NightlyCleanupParams>::new("nightly_cleanup");
let job: Job = handle
    .job_with_params(
        "nightly-job",
        &NightlyCleanupParams {
            retention_days: 7,
        },
    )
    .expect("params serialize");
assert_eq!(job.script_name, "nightly_cleanup");
assert_eq!(job.params_json["retention_days"], 7);

Runnable end-to-end sample: cargo run -p uf-chronon --example script_handle_job --features mem.

Implementations

impl<P> ScriptHandle<P>

pub const fn new(name: &'static str) -> Self

Create a new script handle (typically called by macro-generated code).

pub const fn name(&self) -> &'static str

Stable script registry name.

pub fn job(&self, job_name: impl Into<String>) -> Job

Baseline Job pointing at this script (Job::new defaults).

Populate schedule fields (schedule_kind, cron_expr, next_run_at, …) before upserting via the coordinator service or HTTP API.

impl<P: Serialize> ScriptHandle<P>

pub fn job_with_params( &self, job_name: impl Into<String>, params: &P, ) -> Result<Job>

Baseline Job with typed params serialized into params_json.

Trait Implementations

impl<P: Clone> Clone for ScriptHandle<P>

fn clone(&self) -> ScriptHandle<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for ScriptHandle<P>

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

Formats the value using the given formatter.