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(
    &self,
    servname: Option<&str>,
    channel: Option<&str>
) -> Option<Context<'ph>>

Finds an open context for the given servname and channel.

pub fn nickcmp(&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.

Examples

use hexchat_unsafe_plugin::{ValidContext};

fn join(context: ValidContext<'_, '_>, channel: &str) {
    context.command(&format!("join {}", channel));
}

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

Prints an event message, and returns a success status (whether or not the event exists).

Examples

use hexchat_unsafe_plugin::{ValidContext};

fn emit_channel_message(context: ValidContext<'_, '_>, nick: &str, msg: &str) {
    context.emit_print("Channel Message", [nick, msg]);
}

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

Prints an event message, and returns a success status (whether or not the event exists).

Also allows setting event attributes.

Examples

use std::time::SystemTime;
use hexchat_unsafe_plugin::{EventAttrs, ValidContext};

fn emit_channel_message_at(context: ValidContext<'_, '_>, time: Option<SystemTime>, nick: &str, msg: &str) {
    let mut attrs = EventAttrs::new();
    attrs.server_time = time;
    context.emit_print_attrs(attrs, "Channel Message", [nick, msg]);
}

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

Returns the current context.

See PluginHandle::get_context.

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

Sets the current context.

Returns true if the context is valid, false otherwise.

See PluginHandle::set_context.

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

Prints to the hexchat buffer.

See PluginHandle::print.

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

Prints to the hexchat buffer.

Glue for usage of the write! macro with hexchat.

See PluginHandle::write_fmt.

Panics

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

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

Sets a command hook.

See PluginHandle::hook_command.

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

Sets a server hook.

See PluginHandle::hook_server.

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

Sets a server hook with attributes.

See PluginHandle::hook_server_attrs.

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

Sets a print hook.

See PluginHandle::hook_print.

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

Sets a print hook with attributes.

See PluginHandle::hook_print_attrs.

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

Sets a timer hook.

See PluginHandle::hook_timer.

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

Returns context and client information.

See PluginHandle::get_info.

pub fn get_libdirfs(&self) -> Option<CString>

Returns the plugin directory.

See PluginHandle::get_libdirfs.

pub fn strip(&self, s: &str, strip: Strip) -> String

Strips attributes from text.

See PluginHandle::strip.