Struct hexchat_api::Hook

pub struct Hook { /* private fields */ }

A wrapper for Hexchat callback hooks. These hooks are returned when registering callbacks and can be used to unregister (unhook) them. Hooks can be cloned to share a reference to the same callback hook.

Implementations

impl Hook

pub fn unhook(&self) -> UserData

Unhooks the related callback from Hexchat. The user_data object is returned. Subsequent calls to unhook() will return None. The callback that was registered with Hexchat will be unhooked and dropped. Ownership of the user_data will be passed to the caller.

Returns

• The user data that was registered with the callback using one of the hexchat hook functions.

Trait Implementations

impl Clone for Hook

fn clone(&self) -> Hook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for Hook