Struct hexchat_unsafe_plugin::ValidContext

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

A PluginHandle operating on a valid context.

Methods that require a valid plugin context are only available through this. Methods that may invalidate the plugin context also consume this.

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.

use hexchat_unsafe_plugin::ValidContext;

/// Checks if the two nicks below are equal.
fn compare_nicks(context: ValidContext<'_, '_>) -> bool {
    context.nickcmp("hello", "HELLO").is_eq()
}

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

Sends a list of modes to the current channel.

pub fn get_prefs(&self, name: &str) -> Option<PrefValue>

Returns a client setting.

Examples

use hexchat_unsafe_plugin::ValidContext;

/// Returns the user's configured main nick.
fn main_nick(context: ValidContext<'_, '_>) -> String {
    context.get_prefs("irc_nick1").unwrap().into_string().unwrap()
}

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 list<T: List>(&'a self, t: &'a T) -> Entries<'a, 'ph, T>

Retrieves a list.

Examples

use hexchat_unsafe_plugin::list::Contexts;
use hexchat_unsafe_plugin::PluginHandle;
 
fn print_contexts(ph: &mut PluginHandle<'_>) {
    ph.ensure_valid_context(|ph| {
        let mut contexts = ph.list(&Contexts);
        while let Some(context) = contexts.next() {
            write!(ph, "{}", context.name().unwrap());
        }
    })
}

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.

pub fn pluginpref_set(
    &self,
    var: &str,
    value: &str
) -> Result<(), PluginPrefError>

Sets a pluginpref.

See PluginHandle::pluginpref_set.

pub fn pluginpref_get(&self, var: &str) -> Result<String, PluginPrefError>

Retrieves a pluginpref.

See PluginHandle::pluginpref_get.

pub fn pluginpref_delete(&self, var: &str) -> Result<(), PluginPrefError>

Removes a pluginpref.

See PluginHandle::pluginpref_delete.

pub fn pluginpref_list(&self) -> Result<PluginPrefList, PluginPrefError>

Lists pluginprefs.

See PluginHandle::pluginpref_list.

Methods from Deref<Target = Fields<'a, 'ph, Contexts>>

pub fn name(&self) -> Option<String>

The context’s name.

pub fn channelkey(&self) -> Option<String>

The channel key.

pub fn chanmodes(&self) -> Option<String>

The server’s channel modes. Requires HexChat 2.12.2+.

pub fn chantypes(&self) -> Option<String>

The server’s channel types.

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

The context.

pub fn raw_flags(&self) -> i32

Raw flags about this context.

pub fn server_id(&self) -> i32

The server ID.

pub fn lag(&self) -> i32

The latency to server in milliseconds.

pub fn maxmodes(&self) -> i32

The maximum number of mode changes per line accepted by the server.

pub fn network(&self) -> Option<String>

The network name.

pub fn nickprefixes(&self) -> Option<String>

The server’s nick prefixes.

pub fn nickmodes(&self) -> Option<String>

The server’s nick modes.

pub fn queue_len(&self) -> i32

The current length of the send-queue, in bytes.

pub fn server(&self) -> Option<String>

The server’s name.

pub fn raw_type(&self) -> i32

The context’s raw type.

pub fn users(&self) -> i32

The number of users in the channel.

pub fn address32(&self) -> i32

The raw 32-bit IPv4 address of the remote user.

pub fn rate(&self) -> i32

The transfer rate (speed), in bytes per second.

pub fn destfile(&self) -> Option<String>

The destination file path.

pub fn file(&self) -> Option<String>

The filename.

pub fn nick(&self) -> Option<String>

The remote user’s nick.

pub fn port(&self) -> i32

The listener’s port number.

pub fn raw_pos(&self) -> i32

File position, LSB 32 bits.

pub fn raw_poshigh(&self) -> i32

File position, MSB 32 bits.

pub fn raw_resume(&self) -> i32

Resumed position, LSB 32 bits.

pub fn raw_resumehigh(&self) -> i32

Resumed position, MSB 32 bits.

pub fn raw_size(&self) -> i32

File size, LSB 32 bits.

pub fn raw_sizehigh(&self) -> i32

File size, MSB 32 bits.

pub fn raw_status(&self) -> i32

Raw DCC status.

pub fn raw_type(&self) -> i32

Raw type.

pub fn mask(&self) -> Option<String>

The ignore mask.

pub fn raw_flags(&self) -> i32

Raw ignore flags.

pub fn networks(&self) -> Option<String>

Comma-separated list of networks this notify entry applies to.

pub fn nick(&self) -> Option<String>

The nick.

pub fn raw_flags(&self) -> i32

Raw flags.

pub fn raw_on(&self) -> time_t

Time when the user went online.

pub fn raw_off(&self) -> time_t

Time when the user went offline.

pub fn raw_seen(&self) -> time_t

Time when the user was last seen.

pub fn account(&self) -> Option<String>

Account name.

pub fn away(&self) -> bool

Whether the user is away.

pub fn raw_lasttalk(&self) -> time_t

Time when the user last talked.

pub fn nick(&self) -> Option<String>

User’s nick.

pub fn host(&self) -> Option<String>

User’s user and hostname (user@host).

pub fn prefix(&self) -> Option<String>

User’s prefix.

pub fn userdata(&self) -> Option<String>

User’s userdata.

pub fn selected(&self) -> bool

Whether the user is selected in the UI.

Trait Implementations

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

type Target = Fields<'a, 'ph, Contexts>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.