Enum SnapshotError 

pub enum SnapshotError {
    TruncatedHeader {
        needed: usize,
        actual: usize,
    },
    MalformedHeader,
    BadMagic {
        actual: [u8; 8],
    },
    FormatMajorMismatch {
        actual: u32,
        supported: u32,
    },
    FormatMinorTooNew {
        actual: u32,
        max_supported: u32,
    },
    HeaderSizeMismatch {
        actual: u32,
        expected: u32,
    },
    NonZeroHeaderReserved,
    SectionCountTooLarge {
        count: u32,
        max: u32,
    },
    TruncatedSectionTable {
        needed: usize,
        actual: usize,
    },
    MalformedSectionTable,
    NonZeroEntryChecksum {
        kind: u32,
    },
    NonZeroEntryReserved {
        kind: u32,
    },
    UnsupportedFlags {
        kind: u32,
        flags: u8,
    },
    AlignmentLog2TooLarge {
        kind: u32,
        alignment_log2: u8,
    },
    SectionRangeOverflow {
        kind: u32,
    },
    SectionOutOfBounds {
        kind: u32,
        offset: u64,
        length: u64,
        snapshot_len: u64,
    },
    UnsortedSectionTable {
        index: usize,
    },
    DuplicateKind {
        kind: u32,
    },
    UsizeOverflow {
        value: u64,
    },
}

Snapshot container validation error.

Returned by Snapshot::open and Snapshot::open_with for any header, section table, or layout-level invariant violation.

Performance

perf: unspecified; errors are returned only from validation paths.

Variants

TruncatedHeader

Snapshot bytes were shorter than the fixed header.

Fields

needed: usize

Bytes required for the fixed header.

actual: usize

Bytes actually provided.

MalformedHeader

Header bytes were present but could not be interpreted.

BadMagic

Magic bytes did not match FORMAT_MAGIC.

Fields

actual: [u8; 8]

Actual magic bytes from the snapshot.

FormatMajorMismatch

Format major version did not equal the supported value.

Fields

actual: u32

Major version recorded in the snapshot.

supported: u32

Major version this library supports.

FormatMinorTooNew

Format minor version was newer than this library can read.

Fields

actual: u32

Minor version recorded in the snapshot.

max_supported: u32

Highest minor version this library accepts.

HeaderSizeMismatch

Header header_size field did not match the expected value.

Fields

actual: u32

header_size value recorded in the snapshot.

expected: u32

Header size this library expects.

NonZeroHeaderReserved

Header reserved bytes were not all zero.

SectionCountTooLarge

section_count exceeded the v1 cap.

Fields

count: u32

Section count recorded in the snapshot.

max: u32

Maximum permitted section count.

TruncatedSectionTable

Bytes after the header were too short for the declared section table.

Fields

needed: usize

Bytes required for the declared section table.

actual: usize

Bytes available after the header.

MalformedSectionTable

Section table bytes could not be interpreted.

NonZeroEntryChecksum

A section entry’s reserved_checksum bytes were not all zero.

Fields

kind: u32

Section kind whose entry violated the invariant.

NonZeroEntryReserved

A section entry’s trailing reserved bytes were not all zero.

Fields

kind: u32

Section kind whose entry violated the invariant.

UnsupportedFlags

A section entry declared an unsupported flags bit.

Fields

kind: u32

Section kind whose entry violated the invariant.

flags: u8

Flags byte recorded in the entry.

AlignmentLog2TooLarge

A section entry declared an alignment_log2 larger than permitted.

Fields

kind: u32

Section kind whose entry violated the invariant.

alignment_log2: u8

Declared alignment_log2 value.

SectionRangeOverflow

offset + length overflowed u64 for one entry.

Fields

kind: u32

Section kind whose entry violated the invariant.

SectionOutOfBounds

A section’s byte range fell outside the snapshot.

Fields

kind: u32

Section kind whose entry violated the invariant.

offset: u64

Declared byte offset.

length: u64

Declared byte length.

snapshot_len: u64

Total snapshot byte length.

UnsortedSectionTable

Section table entries were not in monotonic non-decreasing offset order or one entry overlapped its predecessor.

Fields

index: usize

Index of the entry whose offset violated monotonicity.

DuplicateKind

Two section entries shared the same kind.

Fields

kind: u32

Duplicated section kind.

UsizeOverflow

A u64 value could not be represented as usize on this target.

Fields

value: u64

Value that could not be represented as usize.

Trait Implementations

impl Clone for SnapshotError

fn clone(&self) -> SnapshotError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotError

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

Formats the value using the given formatter.

impl Display for SnapshotError

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

Formats the value using the given formatter.

impl Error for SnapshotError

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 SnapshotError

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

impl StructuralPartialEq for SnapshotError