Struct ModifierHook

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

Hook for a modifier, the hook is removed when the object is dropped.

Implementations§

Source§

impl ModifierHook

Source

pub fn new( modifier_name: &str, callback: impl ModifierCallback + 'static, ) -> Result<Self, ()>

Available on unsound only.

Hook a modifier.

§Arguments
  • modifier_name - The modifier to hook.

  • callback - A function or a struct that implements ModifierCallback, the callback method of the trait will be called when the modifier is fired.

§Panics

Panics if the method is not called from the main Weechat thread.

§Example

let modifier_hook = ModifierHook::new(
"input_text_display_with_cursor",
|_weechat: &Weechat,
_modifier_name: &str,
data: Option<ModifierData>,
string: Cow<str>| {
    if let ModifierData::Buffer(buffer) = data? {
        buffer.print("Modifying the input buffer")
    }

    None
});

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, 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.