Enum CheckpointError 

#[non_exhaustive]
pub enum CheckpointError {
    NotInstalled(&'static str),
    UnsupportedFormat {
        found: u32,
    },
    RemovedComponent {
        path: String,
    },
    Json(Error),
    Serialize {
        path: String,
        source: Error,
    },
    Deserialize {
        entity: usize,
        path: String,
        source: Error,
    },
    Unregistered {
        entity: usize,
        path: String,
    },
    HandlerKeyMismatch {
        key: HandlerKey,
    },
    DuplicateSavedHandler {
        key: HandlerKey,
    },
    DuplicateSuppliedHandler {
        key: HandlerKey,
    },
    UnrequiredHandler {
        key: HandlerKey,
    },
    MissingHandler {
        key: HandlerKey,
    },
    MissingSavedHandler {
        key: HandlerKey,
    },
    FamilyChanged {
        key: HandlerKey,
        saved: EffectFamily,
        found: EffectFamily,
    },
    DescriptorChanged {
        key: HandlerKey,
    },
    UnresumableStream,
    Content(ContentError),
    Binary(BinaryError),
    InvalidGraph(&'static str),
}

Why a checkpoint cannot be saved, parsed, validated, or restored.

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.

NotInstalled(&'static str)

The world lacks a resource that RigPlugin installs.

UnsupportedFormat

The envelope is a format other than CHECKPOINT_FORMAT.

Fields

found: u32

The envelope’s format.

RemovedComponent

The checkpoint carries a component this format no longer persists.

Fields

path: String

The removed component’s type path.

Json(Error)

The checkpoint envelope does not serialize to or parse from JSON.

Serialize

A live component does not serialize through reflection.

Fields

path: String

The component’s type path.

source: Error

The serializer’s error.

Deserialize

A saved component does not deserialize as its registered type.

Fields

entity: usize

The entity’s index in Checkpoint::entities.

path: String

The component’s type path.

source: Error

The deserializer’s error.

Unregistered

A saved type path is not a component registered in the destination.

Fields

entity: usize

The entity’s index in Checkpoint::entities.

path: String

The unknown type path.

HandlerKeyMismatch

A saved handler’s binding key differs from its descriptor’s key.

Fields

key: HandlerKey

The binding key.

DuplicateSavedHandler

Two saved handlers share a key.

Fields

key: HandlerKey

The repeated key.

DuplicateSuppliedHandler

The host supplied two handlers for one key.

Fields

key: HandlerKey

The repeated key.

UnrequiredHandler

The host supplied a handler the checkpoint does not require.

Fields

key: HandlerKey

The supplied key.

MissingHandler

A required handler is neither supplied nor installed in the destination.

Fields

key: HandlerKey

The required key.

MissingSavedHandler

An unfinished effect names a handler the checkpoint did not save.

Fields

key: HandlerKey

The effect’s handler key.

FamilyChanged

A handler serves a different effect family than the saved one.

Fields

key: HandlerKey

The handler key.

saved: EffectFamily

The saved family.

found: EffectFamily

The destination’s family.

DescriptorChanged

Under RestoreMode::Strict, a handler’s descriptor differs from the saved one. RestoreMode::Replace accepts the change.

Fields

key: HandlerKey

The handler key.

UnresumableStream

An unfinished stream already delivered progress and has no provider cursor.

Content(ContentError)

A saved utterance does not convert to a message.

Binary(BinaryError)

The saved binary store is invalid or conflicts with the destination’s.

InvalidGraph(&'static str)

The saved graph violates a structural invariant.

Trait Implementations

impl Debug for CheckpointError

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

Formats the value using the given formatter.

impl Display for CheckpointError

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

Formats the value using the given formatter.

impl Error for CheckpointError

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<BinaryError> for CheckpointError

fn from(source: BinaryError) -> Self

Converts to this type from the input type.

impl From<ContentError> for CheckpointError

fn from(source: ContentError) -> Self

Converts to this type from the input type.

impl From<Error> for CheckpointError

fn from(source: Error) -> Self

Converts to this type from the input type.