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,
}

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

Fields

message: String

A short description of the incompatibility

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.

IOError

Fields

io_error: Error

Cause

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

InvalidUtf8

Fields

msg: String

descriptive message

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.

MemoryAllocationLayoutError

Unexpected error with regards to memory layout requirements.

ArrayvecCapacityError

Fields

msg: String

Descriptive message

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

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

Fields

msg: String

Descriptive message

The file does not have a supported version number

GeneralError

Fields

msg: String

Descriptive message

The file does not have a supported version number

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.

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.