Struct ScheduledPrompt 

pub struct ScheduledPrompt {
    pub id: String,
    pub name: String,
    pub schedule: CronExpression,
    pub prompt_template: String,
    pub session_id: Option<String>,
    pub enabled: bool,
    pub metadata: HashMap<String, String>,
}

A prompt template paired with a cron schedule and target pipeline.

Created via ScheduledPrompt::new and registered with a Scheduler. Each ScheduledPrompt carries a unique id (UUID v4) assigned at construction time.

Fields

id: String

Unique identifier, auto-assigned at construction.

name: String

Human-readable label (e.g. "health-check" or "daily-summary").

schedule: CronExpression

The cron expression controlling when this prompt fires.

prompt_template: String

The prompt text template submitted to the pipeline.

session_id: Option<String>

Optional session identifier. When None, a new UUID is used per run.

enabled: bool

Whether this scheduled prompt is currently active.

metadata: HashMap<String, String>

Optional arbitrary metadata forwarded with each submitted request.

Implementations

impl ScheduledPrompt

pub fn new( name: impl Into<String>, cron_expr: &str, prompt_template: impl Into<String>, ) -> Result<Self, OrchestratorError>

Construct a new ScheduledPrompt with a generated UUID and enabled by default.

Errors

Returns OrchestratorError::ConfigError when cron_expr cannot be parsed.

Examples

use tokio_prompt_orchestrator::scheduler::ScheduledPrompt;

let sp = ScheduledPrompt::new("health", "*/5 *", "ping").unwrap();
assert!(sp.enabled);
assert!(!sp.id.is_empty());

pub fn with_session(self, session_id: impl Into<String>) -> Self

Builder: set a fixed session identifier for all runs of this prompt.

Panics

This function does not panic.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Builder: attach extra metadata to every submission.

Panics

This function does not panic.

pub fn disabled(self) -> Self

Builder: start this prompt in a disabled state.

Panics

This function does not panic.

Trait Implementations

impl Clone for ScheduledPrompt

fn clone(&self) -> ScheduledPrompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduledPrompt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScheduledPrompt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScheduledPrompt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.