Enum AllocError

pub enum AllocError {
    OutOfMemory,
    InvalidLayout(Layout),
    CapacityExceeded {
        requested: usize,
        remaining: usize,
    },
}

Error type for allocation failures.

This error is returned when an allocation operation fails, typically due to insufficient memory or other resource constraints.

Examples

use stack_arena::{BufferArena, Allocator, AllocError};
use std::alloc::Layout;

// Create a BufferArena with a small fixed size
let mut arena = BufferArena::with_capacity(4096);

// First allocation succeeds
let layout1 = Layout::from_size_align(4096, 1).unwrap();
let ptr1 = unsafe { arena.allocate(layout1) }.unwrap();

// Second allocation fails due to insufficient space
let layout2 = Layout::from_size_align(1, 1).unwrap();
let result = unsafe { arena.allocate(layout2) };
assert!(result.is_err());
assert!(matches!(result, Err(AllocError::CapacityExceeded { requested: 1, remaining: 0 })));

Note: Unlike BufferArena, the StackArena will automatically allocate new chunks when the current chunk is full, so it rarely returns allocation errors.

Implementation

This error implements the standard Error and Display traits, allowing it to be used with error handling utilities like Result.

Variants

OutOfMemory

InvalidLayout(Layout)

CapacityExceeded

Fields

requested: usize

remaining: usize

Trait Implementations

impl Debug for AllocError

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

Formats the value using the given formatter.

impl Display for AllocError

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

Formats the value using the given formatter.

impl Error for AllocError

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 AllocError

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

impl StructuralPartialEq for AllocError