Enum hexchat_api::HexchatError

pub enum HexchatError {
    CommandFailed(String),
    InfoNotFound(String),
    ThreadSafeOperationFailed(String),
    UnknownType(String),
    ContextAcquisitionFailed(String),
    ContextOperationFailed(String),
    ContextDropped(String),
    ListNotFound(String),
    ListFieldNotFound(String),
    ListIteratorNotStarted(String),
    ListIteratorDropped(String),
}

Each of the various ways the API can fail is collected in this enumerated type.

Variants

CommandFailed(String)

The command failed to execute.

InfoNotFound(String)

The requested info wasn’t found or doesn’t exist.

ThreadSafeOperationFailed(String)

This can happen when a ThreadSafeContext or ThreadSafeListIterator object is used while the plugin is unloading. The main thread task handler isn’t accepting any more tasks, so the operation fails.

UnknownType(String)

The list iterator may return this if the Hexchat API changes. Currently this won’t get thrown.

ContextAcquisitionFailed(String)

The function was unable to acquire the desired context associated with the given network and channel names.

ContextOperationFailed(String)

The context acquisition succeeded, but there is some problem with the action being performed. For instance the requested list for ctx.get_listiter("foo") doesn’t exist.

ContextDropped(String)

The context object was dropped.

ListNotFound(String)

The requested list doesn’t exist.

ListFieldNotFound(String)

The requested field doesn’t exist.

ListIteratorNotStarted(String)

The list iterator type for Hexchat requires that next() be called at least once before its fields are accessible.

ListIteratorDropped(String)

The list iterator object was dropped. This might happen if the plugin is unloading while another thread is still running and using the iterator.

Trait Implementations

impl Clone for HexchatError

fn clone(&self) -> HexchatError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HexchatError

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

Formats the value using the given formatter.

impl Display for HexchatError

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

Formats the value using the given formatter.

impl Error for HexchatError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl Send for HexchatError