Enum hexchat_plugin::InfoId

pub enum InfoId<'a> {
    Away,
    Channel,
    Charset,
    Configdir,
    EventText(&'a str),
    Host,
    Inputbox,
    Libdirfs,
    Modes,
    Network,
    Nick,
    Nickserv,
    Server,
    Topic,
    Version,
    WinStatus,
}

A hexchat_get_info key.

Variants

Away

Returns the away message, or None if the user is not away.

Channel

Returns the current channel name.

Charset

Returns the current charset.

Configdir

Returns the hexchat configuration directory, e.g. /home/user/.config/hexchat.

EventText(&'a str)

Returns the text event format string for the given text event name.

Host

Returns the (real) hostname of the current server.

Inputbox

Returns the contents of the input box.

Libdirfs

Returns the library directory, e.g. /usr/lib/hexchat.

May not always work, as this string isn't necessarily UTF-8, but local file system encoding.

Modes

Returns the channel modes, if known, or None.

Network

Returns the current network name, or None.

Nick

Returns the user's current nick.

Nickserv

Returns the user's nickserv password, if any, or None

Server

Returns the current server name, or None if you are not connected.

Topic

Returns the current channel topic.

Version

Returns the HexChat version string.

WinStatus

Returns the window status: "active", "hidden" or "normal".

Methods

impl<'a> InfoId<'a>

pub fn name(&self) -> Cow<'static, str>

Trait Implementations

impl<'a> Eq for InfoId<'a>

impl<'a> Copy for InfoId<'a>

impl<'a> PartialOrd<InfoId<'a>> for InfoId<'a>

fn partial_cmp(&self, other: &InfoId<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &InfoId<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &InfoId<'a>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &InfoId<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &InfoId<'a>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialEq<InfoId<'a>> for InfoId<'a>

fn eq(&self, other: &InfoId<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &InfoId<'a>) -> bool

This method tests for !=.

impl<'a> Clone for InfoId<'a>

fn clone(&self) -> InfoId<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Ord for InfoId<'a>

fn cmp(&self, other: &InfoId<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> Debug for InfoId<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for InfoId<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].