Enum Error 

#[non_exhaustive]
pub enum Error {
    StaleIndex,
    CapacityExceeded,
    CounterOverflow,
}

Failure modes returned by the public APIs of arena-lib.

The enum is #[non_exhaustive]: callers must include a wildcard arm when matching so future variants can be added in minor releases without breaking source compatibility.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

StaleIndex

The provided index does not point to a live element.

Returned when an Index is used after its slot has been removed and either left vacant or re-issued under a new generation, or when the index was never live in this arena.

CapacityExceeded

An allocation request exceeded the allocator’s available capacity.

Returned by Bump::try_alloc and related fallible allocation entry points when the underlying buffer could not be grown to satisfy the request.

CounterOverflow

A monotonic counter would have wrapped past its representable range.

Returned by Arena::insert and the interner when generation or symbol counters reach their upper bound. Treat this as a permanent failure: drop the affected container and build a new one.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

Available on crate feature std only.

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

Returns 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 PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Error

impl StructuralPartialEq for Error