Struct AllocateError 

pub struct AllocateError<Value = ()> { /* private fields */ }

The error type returned when an allocation fails.

This can either be from an arithmetic error when calculating the layout or from an allocator when allocating.

Implementations

impl<Value> AllocateError<Value>

pub fn handle(self) -> !

Handles the error by calling handle_alloc_error if the alloc feature is enabled, or panicking otherwise.

pub fn into_value(self) -> Value

Gets the value held in the error.

This is usually from attempting to insert the value into a list.

pub fn into_parts(self) -> (Value, AllocateError)

Seperates the value from the error.

pub fn unwrap_result<T>(result: Result<T, Self>) -> T

Unwraps the result using Self::handle when it is an error.

pub const fn layout(&self) -> Option<Layout>

Gets the layout for the allocation.

If this returns None, the layout calculation failed.

pub fn map<U, F>(self, f: F) -> AllocateError<U>

where F: FnOnce(Value) -> U,

Applies a function f to the value.

This maps from an AllocateError<Value> to an AllocateError<U>.

impl AllocateError

pub const fn with_value<Value>(self, value: Value) -> AllocateError<Value>

Places a value into the error.

pub const fn new_layout(source: LayoutError) -> Self

Create a new error from a LayoutError.

pub const fn new_alloc(source: AllocError, layout: Layout) -> Self

Create a new error from a AllocError and the Layout that could not be allocated.

Trait Implementations

impl<Value: Clone> Clone for AllocateError<Value>

fn clone(&self) -> AllocateError<Value>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllocateError

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

Formats the value using the given formatter.

impl Display for AllocateError

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

Formats the value using the given formatter.

impl Error for AllocateError

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<Value> From<AllocateError<Value>> for AllocError

fn from(_value: AllocateError<Value>) -> Self

Converts to this type from the input type.

impl From<LayoutError> for AllocateError

fn from(value: LayoutError) -> Self

Converts to this type from the input type.

impl<Value: PartialEq> PartialEq for AllocateError<Value>

fn eq(&self, other: &AllocateError<Value>) -> 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<Value: Eq> Eq for AllocateError<Value>

impl<Value> StructuralPartialEq for AllocateError<Value>