Struct Keybind

Source

pub struct Keybind { /* private fields */ }

Implementations§

Source §

impl Keybind

Source

pub fn new(keys: &[Keycode]) -> Keybind

Constructs a new Keybind.

§Example

use keybind::{Keybind, Keycode};

let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);

Examples found in repository ?

examples/example.rs (line 4)

3fn main() {
4    let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);
5
6    keybind.on_trigger(|| {
7        println!("This will be printed when you press CTRL+G");
8    });
9
10    keybind.wait();
11}

Source

pub fn triggered(&mut self) -> bool

Returns bool if the specific keybind has been triggered

§Example

use keybind::{Keybind, Keycode};

let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);

loop {
    if self.triggered() {
        println!("triggered");
    }
}

Source

pub fn on_trigger<C: Fn() + 'static>(&mut self, callback: C)

Sets provided callback that will be executed on trigger.

§Example

use keybind::{Keybind, Keycode};

let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);

keybind.on_trigger(|| {
    println!("This will be printed when you press CTRL+G");
});

Examples found in repository ?

examples/example.rs (lines 6-8)

3fn main() {
4    let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);
5
6    keybind.on_trigger(|| {
7        println!("This will be printed when you press CTRL+G");
8    });
9
10    keybind.wait();
11}

Source

pub fn wait(&mut self)

Starts an infinite loop and calls provided callback when the keybind is triggered.

§Example

use keybind::{Keybind, Keycode};

fn main() {
   let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);

   keybind.on_trigger(|| {
       println!("This will be printed when you press CTRL+G");
   });

   keybind.wait();
}

Examples found in repository ?

examples/example.rs (line 10)

3fn main() {
4    let mut keybind = Keybind::new(&[Keycode::LControl, Keycode::G]);
5
6    keybind.on_trigger(|| {
7        println!("This will be printed when you press CTRL+G");
8    });
9
10    keybind.wait();
11}