Struct Hook 

pub struct Hook { /* private fields */ }

A running OS-level mouse hook. Call Hook::stop to tear down.

On macOS a dedicated thread runs a CFRunLoop draining a CGEventTap. On Linux one thread per physical mouse device reads evdev events and re-injects pass-through events via a uinput virtual device. Call stop (or let the value drop) to shut down all threads and release grabbed devices.

Implementations

impl Hook

pub fn start( cb: impl Fn(MouseEvent) -> EventDisposition + Send + Sync + 'static, ) -> Result<Self, HookError>

Install the mouse hook and start delivering events to cb.

The callback runs on a private background thread for every mouse button or scroll event. It must return EventDisposition quickly — blocking it stalls input delivery system-wide.

On macOS, returns HookError::AccessibilityDenied when Accessibility permission has not been granted. On Linux, returns HookError::NoDeviceFound when no mouse device is accessible. On Windows, always returns HookError::Unsupported.

pub fn stop(self)

Stop the hook and release OS resources.

Signals background threads to exit and blocks until they join. Calling this explicitly is preferred over relying on Drop when errors in cleanup should be visible. Drop calls this automatically.

pub fn has_accessibility() -> bool

Returns true when the process has the permissions required to install the hook.

On macOS, checks the Accessibility entitlement. On Linux and Windows this always returns true; those platforms enforce permissions at a lower layer (device node ownership / group membership).

pub fn prompt_accessibility()

Show the macOS Accessibility permission dialog and register this process in System Settings → Privacy & Security → Accessibility.

Unlike Self::has_accessibility, this passes the kAXTrustedCheckOptionPrompt option, so macOS surfaces the native “open System Settings” dialog the first time and lists the app there (otherwise the user would have to add the binary by hand). Called for its side effect; the resulting trust state is observed separately via Self::has_accessibility. No-op on non-macOS.

Trait Implementations

impl Drop for Hook

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.