Enum std::heap::AllocErr

pub enum AllocErr {
    Exhausted {
        request: Layout,
    },
    Unsupported {
        details: &'static str,
    },
}

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

The AllocErr error specifies whether an allocation failure is specifically due to resource exhaustion or if it is due to something wrong when combining the given input arguments with this allocator.

Variants

Exhausted

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

Error due to hitting some resource limit or otherwise running out of memory. This condition strongly implies that some series of deallocations would allow a subsequent reissuing of the original allocation request to succeed.

Fields of Exhausted

request: Layout

🔬 This is a nightly-only experimental API. (allocator_api #32838) the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

Unsupported

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

Error due to allocator being fundamentally incapable of satisfying the original request. This condition implies that such an allocation request will never succeed on the given allocator, regardless of environment, memory pressure, or other contextual conditions.

For example, an allocator that does not support requests for large memory blocks might return this error variant.

Fields of Unsupported

details: &'static str

🔬 This is a nightly-only experimental API. (allocator_api #32838) the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

Methods

impl AllocErr

pub fn invalid_input(details: &'static str) -> AllocErr

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

pub fn is_memory_exhausted(&self) -> bool

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

pub fn is_request_unsupported(&self) -> bool

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

pub fn description(&self) -> &str

🔬 This is a nightly-only experimental API. (allocator_api #32838)

the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

Trait Implementations

impl Clone for AllocErr

fn clone(&self) -> AllocErr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<AllocErr> for AllocErr

fn eq(&self, __arg_0: &AllocErr) -> bool

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

fn ne(&self, __arg_0: &AllocErr) -> bool

This method tests for !=.

impl Display for AllocErr

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

Formats the value using the given formatter.

impl Eq for AllocErr

impl Debug for AllocErr

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for AllocErr

fn description(&self) -> &str

A short description of the error.

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

The lower-level cause of this error, if any.