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.

Preferred scheduling: build jobs with Chronon’s fluent JobBuilder (chronon_scheduler::JobBuilder, re-exported from the chronon / uf-chronon facade) from this handle, then upsert via CoordinatorService or RemoteCoordinatorClient. Self::job / Self::job_with_params only seed script_name / params_json — a low-level alternate to the fluent builder.

Examples

Handle identity (construction lives on Chronon JobBuilder — see cargo run -p uf-chronon --example script_handle_job --features mem):

use chronon_core::ScriptHandle;
use serde::Serialize;

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

let handle = ScriptHandle::<NightlyCleanupParams>::new("nightly_cleanup");
assert_eq!(handle.name(), "nightly_cleanup");

Low-level seed (prefer JobBuilder::params in application code):

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);

Implementations

impl<P> ScriptHandle<P>

pub const fn new(name: &'static str) -> ScriptHandle<P>

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

Prefer Chronon JobBuilder (chronon_scheduler::JobBuilder) for cron / run-once / manual scheduling. This method only seeds job_name and script_name.

impl<P> ScriptHandle<P>

where P: Serialize,

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

Baseline Job with typed params serialized into params_json.

Prefer Chronon JobBuilder::params for fluent construction.

Trait Implementations

impl<P> Clone for ScriptHandle<P>

where P: Clone,

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 for ScriptHandle<P>

where P: Debug,

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

Formats the value using the given formatter.