Struct TaskHandle 

pub struct TaskHandle { /* private fields */ }

A handle that cancels a registered task.

Dropping the handle without calling TaskHandle::cancel leaves the task running (the tokio task holds a clone of the cancellation token). Call TaskHandle::cancel to stop the task explicitly.

Examples

use std::sync::Arc;
use std::time::Duration;
use dynomite::core::task::task_register;

let rt = tokio::runtime::Runtime::new().unwrap();
rt.block_on(async {
    let h = task_register(Duration::from_millis(50), Arc::new(|| {}));
    assert!(!h.is_cancelled());
    h.cancel();
    assert!(h.is_cancelled());
});

Implementations

impl TaskHandle

pub fn cancel(&self)

Cancel the task.

Examples

use std::sync::Arc;
use std::time::Duration;
use dynomite::core::task::task_register;

let rt = tokio::runtime::Runtime::new().unwrap();
rt.block_on(async {
    let h = task_register(Duration::from_millis(50), Arc::new(|| {}));
    h.cancel();
    assert!(h.is_cancelled());
});

pub fn is_cancelled(&self) -> bool

Whether the task has already been cancelled.

Examples

use std::sync::Arc;
use std::time::Duration;
use dynomite::core::task::task_register;

let rt = tokio::runtime::Runtime::new().unwrap();
rt.block_on(async {
    let h = task_register(Duration::from_millis(50), Arc::new(|| {}));
    assert!(!h.is_cancelled());
    h.cancel();
    assert!(h.is_cancelled());
});

Trait Implementations

impl Clone for TaskHandle

fn clone(&self) -> TaskHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskHandle

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

Formats the value using the given formatter.