keysim 0.1.0

a crossplatform library to simulate user inputs
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

use crate::{Button, Key};

/// Stores the state required to simulate inputs.
///
/// On most platforms, this type will be a zero-sized type, but if the current platform requires
/// some kind of state when simulating keypresses, this type is responsible for managing that
/// state.
pub struct Simulator(crate::platform::Simulator);

impl Simulator {
    /// Creates a new [`Simulator`] instance.
    #[inline]
    pub fn new() -> Result<Self, crate::Error> {
        crate::platform::Simulator::new()
            .map(Self)
            .map_err(crate::Error)
    }

    /// Sends a fake key press event to the top-level window.
    #[inline]
    pub fn press_key(&self, key: Key) -> Result<(), crate::Error> {
        self.0.press_key(key).map_err(crate::Error)
    }

    /// Sends a fake key release event to the top-level window.
    #[inline]
    pub fn release_key(&self, key: Key) -> Result<(), crate::Error> {
        self.0.release_key(key).map_err(crate::Error)
    }

    /// Sends a fake keystroke event to the top-level window.
    #[inline]
    pub fn send_key(&self, key: Key) -> Result<(), crate::Error> {
        self.0.send_key(key).map_err(crate::Error)
    }

    /// Sends a fake button press event to the top-level window.
    #[inline]
    pub fn press_button(&self, button: Button) -> Result<(), crate::Error> {
        self.0.press_button(button).map_err(crate::Error)
    }

    /// Sends a fake button release event to the top-level window.
    #[inline]
    pub fn release_button(&self, button: Button) -> Result<(), crate::Error> {
        self.0.release_button(button).map_err(crate::Error)
    }

    /// Sends a fake button click event to the top-level window.
    #[inline]
    pub fn send_button(&self, button: Button) -> Result<(), crate::Error> {
        self.0.send_button(button).map_err(crate::Error)
    }

    /// Sends a unicode code-point to the top-level window.
    #[inline]
    pub fn send_char(&self, c: char) -> Result<(), crate::Error> {
        self.0.send_char(c).map_err(crate::Error)
    }

    /// Sends a bunch of unicode code-points to the top-level window.
    #[inline]
    pub fn send_chars(&self, it: impl IntoIterator<Item = char>) -> Result<(), crate::Error> {
        self.0.send_chars(it.into_iter()).map_err(crate::Error)
    }

    /// Sends a string to the top-level window.
    #[inline]
    pub fn send_str(&self, s: &str) -> Result<(), crate::Error> {
        self.0.send_str(s).map_err(crate::Error)
    }
}