Enum ffi_support::handle_map::HandleError

pub enum HandleError {
    NullHandle,
    InvalidHandle,
    StaleVersion,
    IndexPastEnd,
    WrongMap,
}

An error representing the ways a Handle may be invalid.

Variants

NullHandle

Identical to invalid handle, but has a slightly more helpful message for the most common case 0.

InvalidHandle

Returned from Handle::from_u64 if Handle::is_valid fails.

StaleVersion

Returned from get/get_mut/delete if the handle is stale (this indicates something equivalent to a use-after-free / double-free, etc).

IndexPastEnd

Returned if the handle index references an index past the end of the HandleMap.

WrongMap

The handle has a map_id for a different map than the one it was attempted to be used with.

Trait Implementations

impl From<HandleError> for ExternError

fn from(e: HandleError) -> Self

Performs the conversion.

impl PartialEq<HandleError> for HandleError

fn eq(&self, other: &HandleError) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for HandleError

fn clone(&self) -> HandleError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<HandleError> for HandleError

fn partial_cmp(&self, other: &HandleError) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Eq for HandleError

impl Ord for HandleError

fn cmp(&self, other: &HandleError) -> 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 Display for HandleError

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

Formats the value using the given formatter.

impl Debug for HandleError

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

Formats the value using the given formatter.

impl Fail for HandleError

fn name(&self) -> Option<&str>

Returns the "name" of the error.

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

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

fn backtrace(&self) -> Option<&Backtrace>

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn context<D>(self, context: D) -> Context<D> where
    D: Display + Send + Sync + 'static, 

Provides context for this failure.

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error.