EnsureValidContext

Struct EnsureValidContext 

Source
pub struct EnsureValidContext<'a> { /* private fields */ }
Expand description

A safety wrapper to ensure you’re working with a valid context.

This mechanism attempts to reduce the likelihood of segfaults.

Implementations§

Source§

impl<'a> EnsureValidContext<'a>

Source

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

Finds an open context for the given servname and channel.

Source

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

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

Source

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

Source

pub fn command(self, cmd: &str)

Executes a command.

Source

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

Source

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

Source

pub fn get_context(&mut self) -> Context

Source

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

Sets the current context.

Returns true if the context is valid, false otherwise.

Source

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

Prints to the hexchat buffer.

Source

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

Sets a command hook

Source

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

Sets a server hook

Source

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

Sets a print hook

Source

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

Sets a timer hook

Source

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

Auto Trait Implementations§

§

impl<'a> Freeze for EnsureValidContext<'a>

§

impl<'a> RefUnwindSafe for EnsureValidContext<'a>

§

impl<'a> !Send for EnsureValidContext<'a>

§

impl<'a> !Sync for EnsureValidContext<'a>

§

impl<'a> Unpin for EnsureValidContext<'a>

§

impl<'a> !UnwindSafe for EnsureValidContext<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.