Struct ora::client::ScheduleHandle

pub struct ScheduleHandle { /* private fields */ }

A handle to a schedule that allows inspection and operations.

Implementations

impl ScheduleHandle

pub fn new_raw(ops: Arc<dyn ScheduleOperations, Global>) -> ScheduleHandle

Create a new schedule handle over a raw implementation.

pub fn id(&self) -> Uuid

Return the schedule’s ID.

pub async fn definition( &self ) -> impl Future<Output = Result<ScheduleDefinition, Report>>

Return the schedule’s definition.

pub async fn is_active(&self) -> impl Future<Output = Result<bool, Report>>

Return whether the schedule is currently active, meaning it has a currently running task or there can be more tasks spawned by it in the future.

pub async fn cancelled_at( &self ) -> impl Future<Output = Result<Option<OffsetDateTime>, Report>>

Return whether the schedule was cancelled.

pub async fn active_task( &self ) -> impl Future<Output = Result<Option<TaskHandle<()>>, Report>>

Return the latest active task of the schedule.

A task is considered active if it has not succeeded, has not failed and has not been cancelled.

pub async fn cancel(&self) -> impl Future<Output = Result<(), Report>>

Cancel the schedule and all of its active tasks.

Trait Implementations

impl Clone for ScheduleHandle

fn clone(&self) -> ScheduleHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleHandle

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

Formats the value using the given formatter.