Struct PauseHandle 

pub struct PauseHandle { /* private fields */ }

A handle for signaling the HotkeyManager to stop processing hotkeys without exiting the event loop or unregistering hotkeys. When paused, the HotkeyManager will only process registered pause hotkeys.

The PauseHandle is used to manage the pause state of the HotkeyManager.

Implementations

impl PauseHandle

pub fn toggle(&self)

Toggles the pause state of the HotkeyManager.

If the HotkeyManager is currently paused, calling this method will resume normal hotkey processing. If it is active, calling this method will pause it.

Examples found in repository

examples/handles.rs (line 28)

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");
}

pub fn set(&self, state: bool)

Explicitly sets the pause state.

pub fn is_paused(&self) -> bool

Returns whether the HotkeyManager is currently paused.

When paused, only pause hotkeys will be processed while all others will be ignored.

Trait Implementations

impl Clone for PauseHandle

fn clone(&self) -> PauseHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PauseHandle

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

Formats the value using the given formatter.