Struct HotkeyManager 

pub struct HotkeyManager { /* private fields */ }

Platform-agnostic Hotkey Manager

This manager wraps a KeyboardListener and filters events against registered hotkeys, emitting HotkeyEvents when matches occur.

Registered hotkeys are blocked from reaching other applications. Note: On Linux/Wayland, blocking may not work due to compositor restrictions.

Implementations

impl HotkeyManager

pub fn new() -> Result<Self>

Create a new HotkeyManager (non-blocking mode)

On macOS, this will check for accessibility permissions and fail if not granted.

pub fn new_with_blocking() -> Result<Self>

Create a new HotkeyManager with blocking support

On macOS, this will check for accessibility permissions and fail if not granted. Registered hotkeys will be blocked from reaching other applications.

Note: On Linux/Wayland, blocking may not work due to compositor restrictions.

pub fn register(&self, hotkey: Hotkey) -> Result<HotkeyId>

Register a hotkey and return its unique ID

Returns an error if the hotkey is already registered.

pub fn unregister(&self, id: HotkeyId) -> Result<()>

Unregister a hotkey by its ID

Returns an error if the hotkey ID is not found.

pub fn get_hotkey(&self, id: HotkeyId) -> Option<Hotkey>

Get the hotkey definition associated with an ID

Returns None if the ID is not found.

pub fn recv(&self) -> Result<HotkeyEvent>

Blocking receive for hotkey events

Blocks until a hotkey event is received or the event loop stops.

pub fn try_recv(&self) -> Option<HotkeyEvent>

Non-blocking receive for hotkey events

Returns Some(event) if an event is available, None otherwise.

pub fn hotkey_count(&self) -> usize

Get the number of currently registered hotkeys

Trait Implementations

impl Drop for HotkeyManager

fn drop(&mut self)

Executes the destructor for this type.