Struct JobHandle

pub struct JobHandle<J = ()> { /* private fields */ }

A handle to a single job.

The handle also caches the details of the job, so that they can be accessed without making a network request.

Implementations

impl<J> JobHandle<J>

pub fn id(&self) -> Uuid

Get the ID of the job.

pub async fn details(&self) -> Result<Arc<JobDetails>>

Get the details of the job.

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

Get the status of the job.

pub fn details_cached(&self) -> Option<Arc<JobDetails>>

Get the cached details of the job, if available.

This is useful for getting the details of a job without making a network request.

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

Cancel the job.

pub fn cast_type<T: JobType>(&self) -> JobHandle<T>

Cast the job handle to a specific job type.

This does not perform any runtime checks, so it is up to the caller to ensure that the job type is correct.

pub fn cast_unknown(&self) -> JobHandle

Cast the job handle to an unknown job type.

impl<J> JobHandle<J>

where J: JobType,

pub async fn input(&self) -> Result<J>

Retrieve the input of the job.

pub async fn wait(&self) -> Result<J::Output>

Retrieve the output of the job.

pub async fn wait_with_interval(&self, interval: Duration) -> Result<J::Output>

Retrieve the output of the job with a given polling interval.

Trait Implementations

impl<J> Clone for JobHandle<J>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<J: Debug> Debug for JobHandle<J>

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

Formats the value using the given formatter.

impl<J> IntoFuture for JobHandle<J>

where J: JobType,

type Output = Result<<J as JobType>::Output, Report>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <JobHandle<J> as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.