Struct pliantdb_jobs::task::Handle

pub struct Handle<T, Key> {
    pub id: Id,
    // some fields omitted
}

References a background task.

Fields

id: Id

The task’s id.

Implementations

impl<T, Key> Handle<T, Key> where
    T: Serialize + for<'de> Deserialize<'de> + Send + Sync + 'static,
    Key: Clone + Hash + Eq + Send + Sync + Debug + 'static, 

pub async fn clone(&self) -> Self

Returns a copy of this handle. When the job is completed, both handles will be able to receive() the results.

pub async fn receive(&self) -> Result<Result<T, Arc<Error>>, RecvError>

Waits for the job to complete and returns the result.

Errors

Returns an error if the job is cancelled.

pub fn try_receive(&self) -> Result<Result<T, Arc<Error>>, TryRecvError>

Tries to receive the status of the job. If available, it is returned. This function will not block.

Errors

Returns an error if the job isn’t complete.

• TryRecvError::Disconnected: The job has been cancelled.
• TryRecvError::Empty: The job has not completed yet.

Trait Implementations

impl<T: Debug, Key: Debug> Debug for Handle<T, Key>

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

Formats the value using the given formatter.