Struct InterruptHandle 

pub struct InterruptHandle { /* private fields */ }

A handle for signaling the HotkeyManager to stop its event loop.

The InterruptHandle is used to gracefully interrupt the event loop by sending a control signal. This allows the HotkeyManager to clean up resources and stop processing keyboard events.

Implementations

impl InterruptHandle

pub fn interrupt(&self)

Interrupts the HotkeyManager’s event loop.

This method sets an internal flag to indicate that the interruption has been requested. then sends a dummy keyboard event to the event loop to force it to check the flag.

Examples found in repository

examples/handles.rs (line 35)

fn main() {
    // Create the manager
    let mut hkm = HotkeyManager::new();

    // Register a system-wide hotkey with trigger key 'A' and modifier key 'CTRL'
    hkm.register_hotkey(VKey::A, &[VKey::Control], || {
        println!("Hotkey CTRL + A was pressed");
    })
    .unwrap();

    // Get an interrupt handle that can be used to interrupt / stop the event loop from any thread
    let interrupt_handle = hkm.interrupt_handle();

    // Get a pause handle that can be used to programmatically pause the processing of hotkeys from
    // any thread. Note: registered pause hotkeys will still be processed.
    let pause_handle = hkm.pause_handle();

    // Create a second thread that will pause/interrupt hkm
    spawn(move || {
        sleep(Duration::from_secs(3));

        println!("Pausing hotkeys for 3 seconds");
        pause_handle.toggle();
        sleep(Duration::from_secs(3));

        println!("Unpausing hotkeys");
        pause_handle.toggle();

        sleep(Duration::from_secs(3));
        interrupt_handle.interrupt();
    });

    // Run the event handler in a blocking loop. This will block until interrupted and execute the
    // set callbacks when registered hotkeys are detected
    hkm.event_loop();

    println!("Event Loop interrupted");
}

examples/app_command.rs (line 61)

fn main() {
    // The HotkeyManager is generic over the return type of the callback functions.
    let mut hkm = HotkeyManager::new();
    let modifiers = &[VKey::LWin, VKey::Shift];

    // Register WIN + SHIFT + 1 for app command 1
    hkm.register_hotkey(VKey::Vk1, modifiers, || {
        println!("Pressed WIN + SHIFT + 1");
        AppCommand::AppCommand1
    })
    .unwrap();

    // Register WIN + SHIFT + 2 for app command 2
    hkm.register_hotkey(VKey::Vk2, modifiers, || {
        println!("Pressed WIN + SHIFT + 2");
        AppCommand::AppCommand2
    })
    .unwrap();

    // Register WIN + 3 for app command EXIT
    hkm.register_hotkey(VKey::Vk3, modifiers, || {
        println!("Pressed WIN + SHIFT + 3");
        AppCommand::Exit
    })
    .unwrap();

    // Register channel to receive events from the hkm event loop
    let (tx, rx) = unbounded();
    hkm.register_channel(tx);

    // Run HotkeyManager in background thread
    let handle = hkm.interrupt_handle();
    thread::spawn(move || {
        hkm.event_loop();
    });

    // App Logic
    loop {
        let command = rx.recv().unwrap();

        match command {
            AppCommand::AppCommand1 => {
                println!("Do thing 1");
            }
            AppCommand::AppCommand2 => {
                println!("Do thing 2");
            }
            AppCommand::Exit => {
                println!("Exiting...");
                handle.interrupt();
                break;
            }
        }
    }
}

Trait Implementations

impl Clone for InterruptHandle

fn clone(&self) -> InterruptHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InterruptHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.