matrix_sdk_ffi/
task_handle.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
use tokio::task::JoinHandle;
use tracing::debug;

/// A task handle is a way to keep the handle a task running by itself in
/// detached mode.
///
/// It's a thin wrapper around [`JoinHandle`].
#[derive(uniffi::Object)]
pub struct TaskHandle {
    handle: JoinHandle<()>,
}

impl TaskHandle {
    // Create a new task handle.
    pub fn new(handle: JoinHandle<()>) -> Self {
        Self { handle }
    }
}

#[matrix_sdk_ffi_macros::export]
impl TaskHandle {
    // Cancel a task handle.
    pub fn cancel(&self) {
        debug!("Cancelling the task handle");

        self.handle.abort();
    }

    /// Check whether the handle is finished.
    pub fn is_finished(&self) -> bool {
        self.handle.is_finished()
    }
}

impl Drop for TaskHandle {
    fn drop(&mut self) {
        self.cancel();
    }
}