Enum SnapshotError 

#[non_exhaustive]
pub enum SnapshotError {
    HeaderTruncated {
        expected: usize,
        got: usize,
    },
    BadMagic {
        got: [u8; 8],
    },
    UnsupportedFormat {
        got: u16,
        max: u16,
    },
    SectionTruncated {
        tag: String,
        declared: usize,
        got: usize,
    },
    VersionMismatch {
        tag: String,
        file_version: u8,
        chip_supports: u8,
    },
    SectionInvalid {
        tag: String,
        reason: String,
    },
    MissingSection(String),
    Eof(usize),
}

Errors produced by save-state encode / decode.

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.

HeaderTruncated

The blob is shorter than the header.

Fields

expected: usize

Expected byte count.

got: usize

Actual byte count.

BadMagic

The magic prefix is wrong.

Fields

got: [u8; 8]

Bytes observed at the magic offset.

UnsupportedFormat

The container format version is outside the range we understand.

Fields

got: u16

Version we read.

max: u16

Highest version we accept.

SectionTruncated

A section body is shorter than its declared length.

Fields

tag: String

4-byte tag (printable ASCII).

declared: usize

Declared length.

got: usize

Bytes actually available.

VersionMismatch

A section had a version this build does not handle.

Fields

tag: String

4-byte tag (printable ASCII).

file_version: u8

Version recorded in the file.

chip_supports: u8

Highest version the running chip accepts.

SectionInvalid

A section’s body failed internal consistency checks.

Fields

tag: String

4-byte tag (printable ASCII).

reason: String

Free-form reason.

MissingSection(String)

A required section was missing.

Eof(usize)

A section blob ran past EOF.

Implementations

impl SnapshotError

pub fn invalid(tag: [u8; 4], reason: impl Into<String>) -> Self

Construct a Self::SectionInvalid with a borrowed tag.

Trait Implementations

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 From<SnapshotError> for MovieError

fn from(source: SnapshotError) -> Self

Converts to this type from the input type.