[][src]Struct keybind::Keybind

pub struct Keybind { /* fields omitted */ }

Methods

impl Keybind[src]

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

Constructs a new Keybind.

Example

This example is not tested
use keybind::{Keybind, Keycode};

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

pub fn triggered(&mut self) -> bool[src]

Returns bool if the specific keybind has been triggered

Example

This example is not tested
use keybind::{Keybind, Keycode};

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

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

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

Sets provided callback that will be executed on trigger.

Example

This example is not tested
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");
});

pub fn wait(&mut self)[src]

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

Example

This example is not tested
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();
}

Auto Trait Implementations

impl !Send for Keybind

impl !Sync for Keybind

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.