Skip to main content

GuiProcessWatcher

Struct GuiProcessWatcher 

Source
pub struct GuiProcessWatcher { /* private fields */ }
Expand description

Monitors GUI processes, using the Windows shell hook API.

§Examples

use ib_hook::process::{GuiProcessEvent, GuiProcessWatcher};

let watcher = GuiProcessWatcher::new(Box::new(|event| {
    println!("Process event: {event:?}");
})).unwrap();

println!("Monitoring GUI processes...");
std::thread::sleep(std::time::Duration::from_secs(60));

Implementations§

Source§

impl GuiProcessWatcher

Source

pub fn new(callback: impl GuiProcessCallback) -> Result<Self>

Creates a new GUI process watcher with the given callback.

The callback will be called for each process event (window creation, activation, rude activation, and replacement).

Source

pub fn with_on_hooked( callback: impl GuiProcessCallback, on_hooked: impl FnOnce() + Send + 'static, ) -> Result<Self>

Source

pub fn with_dedup(callback: impl GuiProcessCallback) -> Result<Self>

Creates a new GUI process watcher with a deduplication buffer.

This version deduplicates process events to avoid duplicate notifications when multiple windows are created by the same process.

Source

pub fn with_filter_dedup<I1, I2>( callback: I1, ) -> GuiProcessWatcherWithFilterDedupBuilder<I1, I2>
where I1: GuiProcessCallback, I2: FnMut(GuiProcessEvent) -> bool + Send + 'static,

Creates a new GUI process watcher with a deduplication buffer and filters to reduce syscalls.

This version deduplicates process events to avoid duplicate notifications when multiple windows are created by the same process.

Source§

impl GuiProcessWatcher

Source

pub fn for_each<I1, I2>(f: I1) -> GuiProcessWatcherForEachBuilder<I1, I2>
where I1: FnMut(Pid) + Send + 'static, I2: FnMut(Option<&Path>) -> bool + Send + 'static,

Apply a function on every existing and new GUI process exactly once.

Race condition / TOCTOU is handled in this function, although not perfect. (Processes created after start_time before hooked will be lost, but they can still be detected if they create new windows (and activate windows if create_only is false) in the future, which is likely to happen.)

§Examples
use ib_hook::process::GuiProcessWatcher;

let _watcher = GuiProcessWatcher::for_each(|pid| println!("pid: {pid}"))
    .filter_image_path(|path| {
        path.and_then(|p| p.file_name())
            .is_some_and(|n| n.to_ascii_lowercase() == "notepad.exe")
    })
    .build();
std::thread::sleep(std::time::Duration::from_secs(60));

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more