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
73
74
75
76
77
78

use crate::{Button, Key};

use super::{sys, utils};

/// The simulator on the Windows platform.
#[derive(Default)]
pub struct Simulator;

impl Simulator {
    /// Creates a new [`Simulator`] instance.
    pub fn new() -> Result<Self, super::Error> {
        Ok(Self)
    }

    /// Simulates a key press event.
    pub fn press_key(&self, key: Key) -> Result<(), super::Error> {
        let vk = utils::key_to_vk(key).ok_or(super::Error::UnsupportedKey(key))?;
        let input = utils::make_key_event(vk as _, true);
        sys::send_events(std::slice::from_ref(&input))
    }

    /// Simulates a key release event.
    pub fn release_key(&self, key: Key) -> Result<(), super::Error> {
        let vk = utils::key_to_vk(key).ok_or(super::Error::UnsupportedKey(key))?;
        let input = utils::make_key_event(vk as _, false);
        sys::send_events(std::slice::from_ref(&input))
    }

    /// Simulates a keystroke.
    pub fn send_key(&self, key: Key) -> Result<(), super::Error> {
        let vk = utils::key_to_vk(key).ok_or(super::Error::UnsupportedKey(key))?;
        let inputs = [
            utils::make_key_event(vk as _, true),
            utils::make_key_event(vk as _, false),
        ];
        sys::send_events(&inputs)
    }

    /// Simulates a key press event.
    pub fn press_button(&self, button: Button) -> Result<(), super::Error> {
        let input = utils::make_button_event(button, true);
        sys::send_events(std::slice::from_ref(&input))
    }

    /// Simulates a key release event.
    pub fn release_button(&self, button: Button) -> Result<(), super::Error> {
        let input = utils::make_button_event(button, false);
        sys::send_events(std::slice::from_ref(&input))
    }

    /// Simulates a keystroke.
    pub fn send_button(&self, button: Button) -> Result<(), super::Error> {
        let inputs = [
            utils::make_button_event(button, true),
            utils::make_button_event(button, false),
        ];
        sys::send_events(&inputs)
    }

    /// Sends a specific unicode code-point.
    pub fn send_char(&self, c: char) -> Result<(), super::Error> {
        let inputs = [
            utils::make_char_event(c, true).ok_or(super::Error::UnsupportedChar(c))?,
            utils::make_char_event(c, false).ok_or(super::Error::UnsupportedChar(c))?,
        ];
        sys::send_events(&inputs)
    }

    /// Sends a collection of characters.
    pub fn send_chars(&self, mut it: impl Iterator<Item = char>) -> Result<(), super::Error> {
        it.try_for_each(|c| self.send_char(c))
    }

    /// Types a string.
    pub fn send_str(&self, s: &str) -> Result<(), super::Error> {
        self.send_chars(s.chars())
    }
}