raw-input 0.0.1-alpha.2

A cross-platform library for capturing and simulating global input events (keyboard and mouse).
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
37
38
39
40
41
42
43
44
45

use crate::dispatcher::{CALLBACKS, Status};

/// A handle that allows control over an active event subscription.
/// 
/// It can be used to pause, resume, or permanently remove a callback.
pub struct SubscriptionHandle {
    pub(crate) id: u64,
}

impl SubscriptionHandle {
    /// Pauses the subscription. The callback will not be executed until `resume` is called.
    /// 
    /// # Example
    /// ```no_run
    /// handle.pause();
    /// ```
    pub fn pause(&self) {
        if let Some(mut subscriber) = CALLBACKS.get_mut(&self.id) {
            subscriber.status = Status::Paused;
        }
    }

    /// Resumes a previously paused subscription.
    /// 
    /// # Example
    /// ```no_run
    /// handle.resume();
    /// ```
    pub fn resume(&self) {
        if let Some(mut subscriber) = CALLBACKS.get_mut(&self.id) {
            subscriber.status = Status::Active;
        }
    }

    /// Removes the subscription from the dispatcher. 
    /// The callback will be dropped and never called again.
    /// 
    /// # Example
    /// ```no_run
    /// handle.unsubscribe();
    /// ```
    pub fn unsubscribe(self) {
        CALLBACKS.remove(&self.id);
    }
}