Enum InitError 

#[non_exhaustive]
pub enum InitError {
    AlreadyInitialized,
    Misaligned {
        required: usize,
    },
    InvalidSpan,
    InvalidUsable {
        index: usize,
    },
    MetadataWontFit {
        required_bytes: usize,
    },
    OverlapsRegion {
        other: usize,
    },
}

Structured failure reason for RegionInit::try_init.

These describe the checkable preconditions of initialisation. The remaining unverifiable preconditions live in the # Safety contract instead.

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.

AlreadyInitialized

init already completed successfully.

Misaligned

phys_base fails the implementation’s alignment requirement.

Fields

required: usize

The alignment, in bytes, that was required but not met.

InvalidSpan

span_len is zero, not a base-frame multiple, or overflows the address space.

InvalidUsable

usable[index] is empty, misaligned, out of order, overlapping, or escapes the span.

Fields

index: usize

Index of the offending range in the usable slice.

MetadataWontFit

No usable range is large enough to host the allocator’s metadata.

Fields

required_bytes: usize

Number of contiguous bytes a single usable range would need.

OverlapsRegion

(regioned only) span overlaps the already-initialised region other.

Fields

other: usize

Index of the already-initialised region the span collides with.

Trait Implementations

impl Clone for InitError

fn clone(&self) -> InitError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InitError

impl Debug for InitError

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

Formats the value using the given formatter.

impl Display for InitError

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

Formats the value using the given formatter.

impl Eq for InitError

impl PartialEq for InitError

fn eq(&self, other: &InitError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for InitError