Struct hexchat_api::Context

pub struct Context { /* private fields */ }

Any channel in Hexchat has an associated IRC network name and channel name. The network name and channel name are closely associated with the Hexchat concept of contexts. Hexchat contexts can also be thought of as the tabs, or windows, open in the UI that have the user joined to their various “chat rooms”. To access a specific chat window in Hexchat, its context can be acquired and used. This library’s Context objects represent the Hexchat contexts and can be used to interact with the specific channels/windows/tabs that he user has open. For instance if your plugin needs to output only to specific channels, rather than the default window (which is the one currently open) - it can acquire the appropriate context using Context::find("some-network", "some-channel"), and use the object returned to invoke a command, context.command("SAY hello!"), or print, context.print("Hello!"), or perform other operations.

Implementations

impl Context

pub fn find(network: &str, channel: &str) -> Option<Self>

This will create a new Context object holding an internal pointer to the requested network/channel, if it exists. The object will be returned as a Some<Context> if the context is found, or None if not.

pub fn get() -> Option<Self>

This will create a new Context that represents the currently active context (window/tab, channel/network) open on the user’s screen. An Context object is returned, or None if it couldn’t be obtained.

pub fn set(&self) -> Result<(), HexchatError>

Sets the currently active context to the context the Context object points to internally.

pub fn print(&self, message: &str) -> Result<(), HexchatError>

Prints the message to the Context object’s Hexchat context. This is how messages can be printed to Hexchat windows apart from the currently active one.

pub fn emit_print( &self, event_name: &str, var_args: &[&str] ) -> Result<(), HexchatError>

Issues a print event to the context held by the Context object.

pub fn command(&self, command: &str) -> Result<(), HexchatError>

Issues a command in the context held by the Context object.

pub fn get_info(&self, list: &str) -> Result<String, HexchatError>

Gets information from the channel/window that the Context object holds an internal pointer to.

pub fn list_get(&self, list: &str) -> Result<ListIterator, HexchatError>

Gets a ListIterator from the context held by the Context object.

pub fn network(&self) -> String

Returns the network name associated with the Context object.

pub fn channel(&self) -> String

Returns the channel name associated with the Context object.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Context

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<FieldValue> for Context

fn from(v: FieldValue) -> Self

Converts to this type from the input type.