Skip to main content

Scheduler

Struct Scheduler 

Source
pub struct Scheduler { /* private fields */ }
Expand description

Tokio-based scheduler that fires prompt submissions on a cron-like interval.

The scheduler holds a collection of ScheduledPrompts and a sender end of the pipeline’s input channel. Call Scheduler::spawn to start the background task.

The scheduler checks the current wall-clock time once per minute and fires every matching prompt.

§Thread Safety

Scheduler is Send + Sync and is typically shared as Arc<Scheduler>. The internal prompt list is guarded by a [RwLock] so that prompts can be added and removed without stopping the background task.

Implementations§

Source§

impl Scheduler

Source

pub fn new(tx: Sender<PromptRequest>) -> Self

Create a new Scheduler that submits prompts on tx.

§Panics

This function does not panic.

Source

pub async fn add( &self, prompt: ScheduledPrompt, ) -> Result<String, OrchestratorError>

Register a ScheduledPrompt.

Returns the assigned id (a UUID v4 string) so callers can reference it later with Scheduler::remove or through the web API.

§Errors

Returns OrchestratorError::ConfigError if the prompt is disabled and thus would never fire. Disabled prompts can be added — they are accepted but will not emit requests until re-enabled (e.g. via the web API).

§Panics

This function does not panic.

Source

pub async fn remove(&self, id: &str) -> bool

Remove the scheduled prompt with the given id.

Returns true if a prompt with that ID existed and was removed, false if no matching ID was found.

§Panics

This function does not panic.

Source

pub async fn list(&self) -> Vec<ScheduledPrompt>

Return a snapshot of all registered prompts (including disabled ones).

§Panics

This function does not panic.

Source

pub async fn set_enabled(&self, id: &str, enabled: bool) -> bool

Enable or disable a scheduled prompt by ID.

Returns true when the prompt was found and updated.

§Panics

This function does not panic.

Source

pub fn spawn(self: &Arc<Self>) -> JoinHandle<()>

Spawn the background scheduler task and return its [JoinHandle].

The task loops forever, sleeping until the next minute boundary, then submitting all matching prompts. It stops when the handle is dropped or [JoinHandle::abort] is called.

§Panics

The spawned task does not panic; any submission errors are logged and skipped.

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more