Skip to main content

LuaHook

Struct LuaHook 

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

A hook backed by a Lua function.

The handler function is stored in Lua’s registry via mlua::RegistryKey. A cloned Lua handle provides thread-safe access to the same Lua state (mlua uses internal locking with the send feature).

Thread-safety: Mutex<Lua> is Send + Sync because Lua: Send.

Implementations§

Source§

impl LuaHook

Source

pub fn new( id: String, fql: FqlPattern, point: HookPoint, priority: i32, lua: &Lua, func: &Function, ) -> Result<Self, Error>

Creates a new LuaHook.

Stores func in Lua’s registry and clones the Lua handle for later invocation from any thread.

§Errors

Returns an error if the function cannot be stored in the registry.

Trait Implementations§

Source§

impl Debug for LuaHook

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hook for LuaHook

Source§

fn id(&self) -> &str

Unique identifier for this hook.
Source§

fn fql_pattern(&self) -> &FqlPattern

FQL pattern this hook matches.
Source§

fn hook_point(&self) -> HookPoint

Which lifecycle point this hook fires on.
Source§

fn priority(&self) -> i32

Priority (lower = earlier). Default: 100.
Source§

fn execute(&self, ctx: HookContext) -> HookAction

Execute the hook with the given context. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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
Source§

impl<T> MaybeSend for T
where T: Send,