hexchat_api

Enum HexchatError

Source
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),
    UserDataCastError(String),
}
Expand description

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.

§

UserDataCastError(String)

The UserData cannot be cast to the specified type.

Trait Implementations§

Source§

impl Clone for HexchatError

Source§

fn clone(&self) -> HexchatError

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HexchatError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for HexchatError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for HexchatError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

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

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

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. Read more
Source§

impl Send for HexchatError

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.