Struct ora_api::client::TaskHandle

pub struct TaskHandle<T = ()> { /* private fields */ }

A handle to a task that can be used for further inspections and operations.

Implementations

impl<T> TaskHandle<T>

pub fn new_raw(task_operations: Arc<dyn TaskOperations>) -> Self

Create a new task handle over a raw implementation.

impl<T> TaskHandle<T>

pub const fn id(&self) -> Uuid

Return the task’s ID.

pub async fn status(&self) -> Result<TaskStatus>

Return the task’s current status.

pub async fn target(&self) -> Result<OffsetDateTime>

Return the task’s target timestamp.

pub async fn definition(&self) -> Result<TaskDefinition<T>>

Return the task’s definition.

pub async fn schedule(&self) -> Result<Option<ScheduleHandle>>

Return the task’s schedule, if any.

pub async fn added_at(&self) -> Result<OffsetDateTime>

Return when the task was added.

pub async fn ready_at(&self) -> Result<Option<OffsetDateTime>>

Return when the task was ready.

pub async fn started_at(&self) -> Result<Option<OffsetDateTime>>

Return when the task was started by a worker.

pub async fn succeeded_at(&self) -> Result<Option<OffsetDateTime>>

Return when the task was completed by a worker.

pub async fn failed_at(&self) -> Result<Option<OffsetDateTime>>

Return when the task failed.

pub async fn cancelled_at(&self) -> Result<Option<OffsetDateTime>>

Return when the task was cancelled.

pub async fn cancel(&self) -> Result<()>

Cancel a task, if the task has already finished running, this is a no-op.

pub async fn worker_id(&self) -> Result<Option<Uuid>>

Return the worker’s ID that is associated with the task, if any.

pub fn cast<U>(self) -> TaskHandle<U>

Cast the handle to a different task type or () to erase the type.

Trait Implementations

impl<T> Clone for TaskHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TaskHandle<T>where T: Debug + Unpin,

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

Formats the value using the given formatter.

impl Future for TaskHandle<()>

type Output = Result<TaskOutput, Report>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T> Future for TaskHandle<T>where T: Task + Unpin,

type Output = Result<<T as Task>::Output, Report>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.