Struct nvim_utils::prelude::LuaHookTriggers

pub struct LuaHookTriggers {
    pub on_calls: bool,
    pub on_returns: bool,
    pub every_line: bool,
    pub every_nth_instruction: Option<u32>,
}

Determines when a hook function will be called by Lua.

Fields

on_calls: bool

Before a function call.

on_returns: bool

When Lua returns from a function.

every_line: bool

Before executing a new line, or returning from a function call.

every_nth_instruction: Option<u32>

After a certain number of VM instructions have been executed. When set to Some(count), count is the number of VM instructions to execute before calling the hook.

Performance

Setting this option to a low value can incur a very high overhead.

Implementations

impl HookTriggers

pub fn on_calls() -> HookTriggers

Returns a new instance of HookTriggers with on_calls trigger set.

pub fn on_returns() -> HookTriggers

Returns a new instance of HookTriggers with on_returns trigger set.

pub fn every_line() -> HookTriggers

Returns a new instance of HookTriggers with every_line trigger set.

pub fn every_nth_instruction(n: u32) -> HookTriggers

Returns a new instance of HookTriggers with every_nth_instruction trigger set.

Trait Implementations

impl BitOr<HookTriggers> for HookTriggers

type Output = HookTriggers

The resulting type after applying the | operator.

fn bitor( self, rhs: HookTriggers ) -> <HookTriggers as BitOr<HookTriggers>>::Output

Performs the | operation.

impl BitOrAssign<HookTriggers> for HookTriggers

fn bitor_assign(&mut self, rhs: HookTriggers)

Performs the |= operation.

impl Clone for HookTriggers

fn clone(&self) -> HookTriggers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HookTriggers

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

Formats the value using the given formatter.

impl Default for HookTriggers

fn default() -> HookTriggers

Returns the “default value” for a type.

impl Copy for HookTriggers