virtual-file-transfer 0.1.0

Transfer in-memory, generated, or archived data as files via Windows drag-and-drop and clipboard without staging temporary files
Documentation 
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

use std::sync::{
    Arc,
    atomic::{AtomicBool, Ordering},
};

/// A shareable token for requesting cooperative transfer cancellation.
///
/// Clones refer to the same cancellation state. Calling [`Self::cancel`] on
/// any clone makes [`Self::is_cancelled`] return `true` on every clone.
/// Cancellation cannot be reset. An in-progress blocking read is not
/// interrupted immediately; cancellation is checked at defined points in
/// the transfer implementation.
#[derive(Clone, Default)]
pub struct CancellationToken {
    cancelled: Arc<AtomicBool>,
}

impl CancellationToken {
    /// Creates a token in the non-cancelled state.
    pub fn new() -> Self {
        Self::default()
    }

    /// Requests cancellation for every operation sharing this token.
    ///
    /// This method returns immediately and does not wait for a read or transfer
    /// to stop.
    pub fn cancel(&self) {
        self.cancelled.store(true, Ordering::Relaxed);
    }

    /// Returns whether cancellation has been requested.
    pub fn is_cancelled(&self) -> bool {
        self.cancelled.load(Ordering::Relaxed)
    }
}