Enum GcError 

#[non_exhaustive]
pub enum GcError {
    CapacityExhausted,
}

The reason a value could not be allocated into a Heap.

The heap addresses its slots with a 32-bit index, so it can hold up to u32::MAX + 1 distinct slots over its lifetime. Slots are reused as objects are reclaimed, so this ceiling counts simultaneously live plus never-yet-freed slots, not total allocations — a program that allocates and collects in a steady loop never approaches it. Reaching the ceiling is the one recoverable failure an allocation can hit; Heap::try_alloc reports it through this type instead of aborting, so a runtime driving the heap from untrusted input can fail cleanly rather than crash.

The enum is #[non_exhaustive]: a later phase may add a second failure mode (for example, a per-heap byte budget), and a match on this type must already account for it.

Examples

use gc_lang::{GcError, Heap, Trace, Tracer};

struct Leaf;
impl Trace for Leaf {
    fn trace(&self, _: &mut Tracer<'_>) {}
}

// The fallible path returns this type; the happy path yields a handle.
let mut heap: Heap<Leaf> = Heap::new();
let handle = heap.try_alloc(Leaf).expect("the first slot is always available");
assert!(heap.get(handle).is_some());

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.

CapacityExhausted

The heap’s slot space is full: it already addresses u32::MAX + 1 slots and cannot represent another handle.

This is unreachable for any realistic workload — it takes more than four billion slots that were never reclaimed — but it is reported rather than ignored so the limit is a defined boundary, never a silent wrap. When it does occur, run a collection to reclaim dead slots before allocating again.

Trait Implementations

impl Clone for GcError

fn clone(&self) -> GcError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GcError

impl Debug for GcError

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

Formats the value using the given formatter.

impl Display for GcError

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

Formats the value using the given formatter.

impl Eq for GcError

impl Error for GcError

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 GcError

fn eq(&self, other: &GcError) -> 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 StructuralPartialEq for GcError