Struct hexchat_unsafe_plugin::ValidContext

pub struct ValidContext<'a, 'ph: 'a> { /* private fields */ }

A PluginHandle operating on a valid context.

This mechanism attempts to reduce the likelihood of segfaults in hexchat code.

See also PluginHandle::ensure_valid_context.

Implementations

impl<'a, 'ph: 'a> ValidContext<'a, 'ph>

pub fn find_context(
    &mut self,
    servname: Option<&str>,
    channel: Option<&str>
) -> Option<Context<'ph>>

Finds an open context for the given servname and channel.

pub fn nickcmp(&mut self, nick1: &str, nick2: &str) -> Ordering

Compares two nicks based on the server’s case mapping.

pub fn send_modes<'b, I: IntoIterator<Item = &'b str>>(
    &mut self,
    iter: I,
    mpl: i32,
    sign: char,
    mode: char
)

pub fn command(self, cmd: &str)

Executes a command.

pub fn emit_print<'b, I: IntoIterator<Item = &'b str>>(
    self,
    event: &str,
    args: I
) -> bool

pub fn emit_print_attrs<'b, I: IntoIterator<Item = &'b str>>(
    self,
    attrs: EventAttrs<'_>,
    event: &str,
    args: I
) -> bool

pub fn get_context(&mut self) -> Context<'ph>

pub fn set_context(&mut self, ctx: &Context<'ph>) -> bool

Sets the current context.

Returns true if the context is valid, false otherwise.

pub fn print<T: ToString>(&mut self, s: T)

Prints to the hexchat buffer.

pub fn write_fmt(&mut self, fmt: Arguments<'_>)

Prints to this hexchat buffer.

Glue for usage of the write! macro with hexchat.

Panics

This panics if any broken formatting trait implementations are used in the format arguments. See also format!.

pub fn hook_command<F>(
    &mut self,
    cmd: &str,
    pri: i32,
    help: Option<&str>,
    cb: F
) -> HookHandle<'ph> where
    F: Fn(&mut PluginHandle<'ph>, Word<'_>, WordEol<'_>) -> Eat + 'ph + RefUnwindSafe, 

Sets a command hook

pub fn hook_server<F>(&mut self, cmd: &str, pri: i32, cb: F) -> HookHandle<'ph> where
    F: Fn(&mut PluginHandle<'ph>, Word<'_>, WordEol<'_>) -> Eat + 'ph + RefUnwindSafe, 

Sets a server hook

pub fn hook_server_attrs<F>(
    &mut self,
    cmd: &str,
    pri: i32,
    cb: F
) -> HookHandle<'ph> where
    F: Fn(&mut PluginHandle<'ph>, Word<'_>, WordEol<'_>, EventAttrs<'_>) -> Eat + 'ph + RefUnwindSafe, 

Sets a server hook with attributes

pub fn hook_print<F>(&mut self, name: &str, pri: i32, cb: F) -> HookHandle<'ph> where
    F: Fn(&mut PluginHandle<'ph>, Word<'_>) -> Eat + 'ph + RefUnwindSafe, 

Sets a print hook

pub fn hook_print_attrs<F>(
    &mut self,
    name: &str,
    pri: i32,
    cb: F
) -> HookHandle<'ph> where
    F: Fn(&mut PluginHandle<'ph>, Word<'_>, EventAttrs<'_>) -> Eat + 'ph + RefUnwindSafe, 

Sets a print hook with attributes

pub fn hook_timer<F>(&mut self, timeout: i32, cb: F) -> HookHandle<'ph> where
    F: Fn(&mut PluginHandle<'ph>) -> bool + 'ph + RefUnwindSafe, 

Sets a timer hook

pub fn get_info<'b>(&'b mut self, id: InfoId<'_>) -> Option<&'b str>