Struct GcHeapOutOfMemory 

pub struct GcHeapOutOfMemory<T> { /* private fields */ }

An error returned when attempting to allocate a GC-managed object, but the GC heap is out of memory.

This error wraps an inner T value – which is the host value, if any, that was passed to [ExternRef::new][crate::ExternRef::new] – and you can recover this value via the into_inner method. This lets you try to allocate the externref again, after performing a GC to hopefully free up space in the heap, or otherwise do whatever you want with the inner value.

For errors that occur when attempting to allocate non-externref objects when the GC heap is at capacity, the T type parameter is just the unit type ().

Implementations

impl<T> GcHeapOutOfMemory<T>

pub fn into_inner(self) -> T

Recover this error’s inner host value.

pub fn take_inner(self) -> (T, GcHeapOutOfMemory<()>)

Take this error’s inner host value, but also retain this GcHeapOutOfMemory with T replaced with ().

This allows you to both extract the inner T if necessary, and also pass the GcHeapOutOfMemory error to [Store::gc][crate::Store::gc] calls.

Trait Implementations

impl<T> Debug for GcHeapOutOfMemory<T>

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

Formats the value using the given formatter.

impl<T> Display for GcHeapOutOfMemory<T>

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

Formats the value using the given formatter.

impl<T> Error for GcHeapOutOfMemory<T>

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.