Enum rkyv::validation::validators::ArchiveError

pub enum ArchiveError {
    Overflow {
        base: *const u8,
        offset: isize,
    },
    Underaligned {
        expected_align: usize,
        actual_align: usize,
    },
    OutOfBounds {
        base: *const u8,
        offset: isize,
        range: Range<*const u8>,
    },
    Overrun {
        ptr: *const u8,
        size: usize,
        range: Range<*const u8>,
    },
    Unaligned {
        ptr: *const u8,
        align: usize,
    },
    SubtreePointerOutOfBounds {
        ptr: *const u8,
        subtree_range: Range<*const u8>,
    },
    SubtreePointerOverrun {
        ptr: *const u8,
        size: usize,
        subtree_range: Range<*const u8>,
    },
    RangePoppedOutOfOrder {
        expected_depth: usize,
        actual_depth: usize,
    },
    UnpoppedSubtreeRanges {
        last_range: usize,
    },
    ExceededMaximumSubtreeDepth {
        max_subtree_depth: usize,
    },
}

Errors that can occur when checking archive memory.

Variants

Overflow

Fields

base: *const u8

The base pointer

offset: isize

The offset

Computing the target of a relative pointer overflowed

Underaligned

Fields

expected_align: usize

The expected alignment of the archive

actual_align: usize

The actual alignment of the archive

The archive is under-aligned for one of the types inside

OutOfBounds

Fields

base: *const u8

The base of the relative pointer

offset: isize

The offset of the relative pointer

range: Range<*const u8>

The pointer range of the archive

A pointer pointed outside the bounds of the archive

Overrun

Fields

ptr: *const u8

The pointer to the type

size: usize

The desired size of the type

range: Range<*const u8>

The pointer range of the archive

There wasn’t enough space for the desired type at the pointed location

Unaligned

Fields

ptr: *const u8

The pointer to the type

align: usize

The required alignment of the type

The pointer wasn’t aligned properly for the desired type

SubtreePointerOutOfBounds

Fields

ptr: *const u8

The pointer to the subtree

subtree_range: Range<*const u8>

The subtree range

The pointer wasn’t within the subtree range

SubtreePointerOverrun

Fields

ptr: *const u8

The pointer to the subtree type,

size: usize

The desired size of the type

subtree_range: Range<*const u8>

The subtree range

There wasn’t enough space in the subtree range for the desired type at the pointed location

RangePoppedOutOfOrder

Fields

expected_depth: usize

The expected depth of the range

actual_depth: usize

The actual depth of the range

A subtree range was popped out of order.

Subtree ranges must be popped in the reverse of the order they are pushed.

UnpoppedSubtreeRanges

Fields

last_range: usize

The depth of the last subtree that was pushed

A subtree range was not popped before validation concluded.

ExceededMaximumSubtreeDepth

Fields

max_subtree_depth: usize

The maximum depth that subtrees may be validated down to

The maximum subtree depth was reached or exceeded.

Trait Implementations

impl Debug for ArchiveError

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

Formats the value using the given formatter.

impl Display for ArchiveError

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

Formats the value using the given formatter.

impl Error for ArchiveError

fn source(&self) -> Option<&(dyn Error + 'static)>

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

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl Send for ArchiveError

impl Sync for ArchiveError