Struct ScheduledTaskGroup 

pub struct ScheduledTaskGroup { /* private fields */ }

Represents scheduled task group.

Implementations

impl ScheduledTaskGroup

pub fn new(group: TaskGroup) -> Self

Creates a new ScheduledTaskGroup.

pub fn group(&self) -> &TaskGroup

Returns the group.

pub fn schedule<F, Fut>( &self, config: ScheduledTaskConfig, policy: ScheduledExecutionPolicy, task: F, ) -> RuntimeResult<ScheduledTaskRegistrationOutcome>

where F: FnMut() -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Schedules task with the cadence of config and the run limits of policy.

The driver and runs belong to this group and stop when it is cancelled. A fixed-delay schedule runs task on its driver; a fixed-rate schedule starts each run as its own task once a run slot is free. A duplicate name leaves the existing registration unchanged.

Errors

Returns an unsupported error when the period is zero or policy contradicts the mode of config: fixed-delay and non-overlapping schedules need a serial policy, an overlapping schedule needs a bounded one. Returns an operational error when the driver cannot be spawned.

pub fn schedule_operation<F, Fut>( &self, operation: &OperationContext, config: ScheduledTaskConfig, policy: ScheduledExecutionPolicy, task: F, ) -> RuntimeResult<ScheduledTaskRegistrationOutcome>

where F: FnMut() -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Schedules task like Self::schedule as part of a bounded operation.

The driver and runs are registered with this group’s fixed component owner and stop when the operation is cancelled or reaches its deadline.

Errors

Returns the same errors as Self::schedule.

pub fn schedule_controlled<F, Fut>( &self, config: ScheduledTaskConfig, task: F, ) -> RuntimeResult<ScheduledTaskRegistrationOutcome>

where F: FnMut() -> Fut + Send + 'static, Fut: Future<Output = ScheduledTaskControl> + Send + 'static,

Schedules fixed-delay work that can end its own schedule.

The schedule stops after a run returns ScheduledTaskControl::Stop.

Errors

Returns an unsupported error when the period is zero or config is not a fixed-delay schedule, and an operational error when the driver cannot be spawned.

pub fn snapshot(&self) -> Vec<ScheduledTaskSnapshot>

Returns the snapshot.

pub fn observer(&self, names: &[&str]) -> ScheduledTaskObserver

Observes a fixed selection of schedule names without keeping tasks alive.

Duplicate names are removed. Callers should select component-level jobs, not names derived from requests or resources.

pub fn clear_completed(&self) -> RuntimeResult<()>

Clears completed schedule registrations so a fixed component owner can start a new operation generation with the same schedule names.

Errors

Returns an error while the component group still has active tasks.

pub async fn shutdown(&self, timeout: Duration) -> ShutdownReport

Shuts down the owned service.

pub async fn shutdown_until(&self, deadline: ShutdownDeadline) -> ShutdownReport

Shuts down the owned service using one absolute deadline.

Trait Implementations

impl Clone for ScheduledTaskGroup

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduledTaskGroup

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

Formats the value using the given formatter.