Struct TaskScheduler

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

Main task scheduler

Implementations§

Source§

impl TaskScheduler

Source

pub fn new(config: SchedulerConfig) -> Self

Create a new task scheduler

Source

pub async fn start(&self) -> SchedulerResult<()>

Start the scheduler

Source

pub async fn stop(&self) -> SchedulerResult<()>

Stop the scheduler

Source

pub async fn schedule_job( &self, task: Arc<Task>, trigger: Arc<dyn Trigger>, ) -> SchedulerResult<String>

Schedule a new job

Source

pub async fn schedule_job_with_id( &self, job_id: impl Into<String>, task: Arc<Task>, trigger: Arc<dyn Trigger>, ) -> SchedulerResult<String>

Schedule a job with a specific ID

Source

pub async fn unschedule_job(&self, job_id: &str) -> SchedulerResult<()>

Unschedule a job

Source

pub async fn set_job_enabled( &self, job_id: &str, enabled: bool, ) -> SchedulerResult<()>

Enable or disable a job

Source

pub async fn get_job(&self, job_id: &str) -> Option<ScheduledJob>

Get job information

Source

pub async fn get_all_jobs(&self) -> Vec<ScheduledJob>

Get all jobs

Source

pub async fn get_jobs_by_group(&self, group: &str) -> Vec<ScheduledJob>

Get jobs by task group

Source

pub async fn execute_job_now(&self, job_id: &str) -> SchedulerResult<String>

Execute a job immediately (ad-hoc execution)

Source

pub async fn schedule_delayed_job( &self, task: Arc<Task>, delay: Duration, ) -> SchedulerResult<String>

Schedule a delayed job (execute once after delay)

Source

pub async fn schedule_delayed_job_with_id( &self, job_id: impl Into<String>, task: Arc<Task>, delay: Duration, ) -> SchedulerResult<String>

Schedule a delayed job with specific ID

Source

pub async fn schedule_interval_job_with_delay( &self, task: Arc<Task>, interval: Duration, initial_delay: Duration, ) -> SchedulerResult<String>

Schedule an interval job with initial delay

Source

pub async fn schedule_interval_job_with_delay_and_id( &self, job_id: impl Into<String>, task: Arc<Task>, interval: Duration, initial_delay: Duration, ) -> SchedulerResult<String>

Schedule an interval job with initial delay and specific ID

Source

pub async fn execute_job_now_with_delay( &self, job_id: &str, execution_delay: Option<Duration>, ) -> SchedulerResult<String>

Execute a job immediately with optional execution delay

Source

pub async fn get_execution(&self, execution_id: &str) -> Option<TaskExecution>

Get task execution

Source

pub async fn cancel_execution(&self, execution_id: &str) -> SchedulerResult<()>

Cancel a running task execution

Source

pub async fn get_status(&self) -> SchedulerStatus

Get scheduler status

Trait Implementations§

Source§

impl Default for TaskScheduler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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, 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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