Enum savefile::SavefileError

#[non_exhaustive]
pub enum SavefileError {
    IncompatibleSchema {
        message: String,
    },
    IOError {
        io_error: Error,
    },
    InvalidUtf8 {
        msg: String,
    },
    MemoryAllocationLayoutError,
    ArrayvecCapacityError {
        msg: String,
    },
    ShortRead,
    CryptographyError,
    SizeOverflow,
    WrongVersion {
        msg: String,
    },
    GeneralError {
        msg: String,
    },
    PoisonedMutex,
    CompressionSupportNotCompiledIn,
    InvalidChar,
    IncompatibleSavefileLibraryVersion,
    MissingMethod {
        method_name: String,
    },
    TooManyArguments,
    CalleePanic {
        msg: String,
    },
    LoadLibraryFailed {
        libname: String,
        msg: String,
    },
    LoadSymbolFailed {
        libname: String,
        symbol: String,
        msg: String,
    },
}

This object represents an error in deserializing or serializing an item.

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.

IncompatibleSchema

Error given when the schema stored in a file, does not match the schema given by the data structures in the code, taking into account versions.

Fields

message: String

A short description of the incompatibility

IOError

Some sort of IO failure. Permissions, broken media etc …

Fields

io_error: Error

Cause

InvalidUtf8

The binary data which is being deserialized, contained an invalid utf8 sequence where a String was expected. If this occurs, it is either a bug in savefile, a bug in an implementation of Deserialize, Serialize or WithSchema, or a corrupt data file.

Fields

msg: String

descriptive message

MemoryAllocationLayoutError

Unexpected error with regards to memory layout requirements.

ArrayvecCapacityError

An Arrayvec had smaller capacity than the size of the data in the binary file.

Fields

msg: String

Descriptive message

ShortRead

The reader returned fewer bytes than expected

CryptographyError

Cryptographic checksum mismatch. Probably due to a corrupt file.

SizeOverflow

A persisted value of isize or usize was greater than the maximum for the machine. This can happen if a file saved by a 64-bit machine contains an usize or isize which does not fit in a 32 bit word.

WrongVersion

The file does not have a supported version number

Fields

msg: String

Descriptive message

GeneralError

The file does not have a supported version number

Fields

msg: String

Descriptive message

PoisonedMutex

A poisoned mutex was encountered when traversing the object being saved

CompressionSupportNotCompiledIn

File was compressed, or user asked for compression, but bzip2-library feature was not enabled.

InvalidChar

Invalid char, i.e, a serialized value expected to be a char was encountered, but it had an invalid value.

IncompatibleSavefileLibraryVersion

This occurs for example when using the stable ABI-functionality to call into a library, and then it turns out that library uses a future, incompatible, Savefile-library version.

MissingMethod

This occurs if a foreign ABI entry point is missing a method

Fields

method_name: String

The name of the missing method

TooManyArguments

Savefile ABI only supports at most 63 arguments per function

CalleePanic

An ABI callee panicked

Fields

msg: String

Descriptive message

LoadLibraryFailed

Loading an extern library failed (only relevant for savefile-abi)

Fields

libname: String

The library being loaded

msg: String

Possible descriptive message

LoadSymbolFailed

Loading an extern library failed (only relevant for savefile-abi)

Fields

libname: String

The library being loaded

symbol: String

The symbol being loaded

msg: String

Possible descriptive message

Implementations

impl SavefileError

pub fn general(something: impl Display) -> SavefileError

Construct a SavefileError::GeneralError using the given string

Trait Implementations

impl Debug for SavefileError

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

Formats the value using the given formatter.

impl Display for SavefileError

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

Formats the value using the given formatter.

impl Error for SavefileError

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

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<T> From<CapacityError<T>> for SavefileError

fn from(s: CapacityError<T>) -> SavefileError

Converts to this type from the input type.

impl From<Error> for SavefileError

fn from(s: Error) -> SavefileError

Converts to this type from the input type.

impl From<FromUtf8Error> for SavefileError

fn from(s: FromUtf8Error) -> SavefileError

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for SavefileError

fn from(_: PoisonError<T>) -> SavefileError

Converts to this type from the input type.

impl From<Utf8Error> for SavefileError

fn from(value: Utf8Error) -> Self

Converts to this type from the input type.