Struct InlineHook 

pub struct InlineHook<F: FnPtr> { /* private fields */ }

Available on crate feature inline only.

Type-safe and RAII (drop guard) wrapper of an inline hook.

Manages the lifetime of a detour hook, providing easy enable/disable and cleanup through RAII principles.

See inline module for details.

Type Parameters

• F: The function type being hooked.

Implementations

impl<F: FnPtr> InlineHook<F>

pub fn with_enabled(target: F, detour: F, enable: bool) -> Result<Self, HRESULT>

Creates a new InlineHookGuard and immediately applies the hook.

Arguments

• enable: Whether to enable the hook immediately (true = enable, false = disable)
• target: Pointer to the target function to hook
• detour: Pointer to the detour/hooked function

Returns

• Ok(InlineHookGuard) if hook creation succeeds
• HRESULT error if hook creation fails

pub const fn new(target: F, detour: F) -> Self

Creates a new InlineHookGuard without immediately enabling it.

Arguments

• target: Pointer to the target function to hook
• detour: Pointer to the detour/hooked function

Returns

InlineHookGuard with the hook not yet applied. Call enable() to apply it.

pub fn new_enabled(target: F, detour: F) -> Result<Self, HRESULT>

Creates a new InlineHookGuard with the hook enabled.

Arguments

• target: Pointer to the target function to hook
• detour: Pointer to the detour/hooked function

Returns

• Ok(InlineHookGuard) with the hook created and enabled
• HRESULT error if hook creation fails

pub fn set_enabled(&mut self, enable: bool) -> HRESULT

Enables or disables the hook.

Arguments

• enable: true to enable, false to disable

Returns

• HRESULT success or error code

pub fn enable(&mut self) -> HRESULT

Enables the hook.

Returns

• Ok(()) if the hook is enabled successfully (or already enabled)
• HRESULT error if enabling fails

pub fn disable(&mut self) -> HRESULT

Disables the hook.

Returns

• Ok(()) if the hook is disabled successfully (or not enabled)
• HRESULT error if disabling fails

pub fn toggle(&mut self) -> HRESULT

Toggles the hook state (enabled -> disabled, disabled -> enabled).

Returns

• Ok(()) if toggle succeeds
• HRESULT error if toggle fails

pub fn is_enabled(&self) -> bool

Returns true if the hook is currently enabled.

pub const fn target(&self) -> F

Returns the target function being hooked.

pub fn is_target(&self, other: F) -> bool

Returns true if other is the same target function as this hook.

This is mainly for avoiding the warning if not using std::ptr::fn_addr_eq().

pub const fn detour(&self) -> F

Returns the detour function that will be called when the hook is active.

pub const fn trampoline(&self) -> F

Returns the trampoline function holding the original target implementation.

When the hook is enabled, calling target() redirects to detour(), while trampoline() provides access to the original target functionality.

pub unsafe fn cast<F2: FnPtr>(&self) -> &InlineHook<F2>

pub unsafe fn cast_mut<F2: FnPtr>(&mut self) -> &mut InlineHook<F2>

pub unsafe fn cast_into<F2: FnPtr>(self) -> InlineHook<F2>

pub unsafe fn into_type_erased(self) -> InlineHook<fn()>

Trait Implementations

impl<F: Debug + FnPtr> Debug for InlineHook<F>

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

Formats the value using the given formatter.

impl<F: FnPtr> Drop for InlineHook<F>

fn drop(&mut self)

Executes the destructor for this type.