Enum ApplyError 

#[non_exhaustive]
pub enum ApplyError {
    Parse(ParseError),
    Io {
        path: Option<PathBuf>,
        source: Error,
    },
    UnsupportedPlatform(u16),
    Cancelled,
    SchemaVersionMismatch {
        kind: &'static str,
        found: SchemaVersion,
        expected: SchemaVersion,
    },
}

Failures produced by the apply layer (crate::apply).

Wraps ParseError because the sequential apply driver (crate::ApplyConfig::apply_patch) parses chunks as it applies them.

#[non_exhaustive]: apply-side failure modes (new I/O kinds surfaced as their own variants, new cancellation reasons) accumulate over time.

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.

Parse(ParseError)

A parse failure surfaced while the apply driver was pulling chunks.

Io

An I/O operation against the install root failed.

path carries the file or directory the operation was targeting when it has been threaded through; it is None for operations whose path context is not readily available (e.g. raw ? propagation from a helper that does not know the path).

Fields

path: Option<PathBuf>

Path the failing operation was targeting, if known.

source: Error

Underlying std::io::Error.

UnsupportedPlatform(u16)

SqPack path resolution refused to fall back to a default platform layout.

Cancelled

Apply was cancelled by an crate::ApplyObserver.

SchemaVersionMismatch

A persisted record’s schema_version does not match this build.

Fields

kind: &'static str

Type name whose schema the mismatch refers to.

found: SchemaVersion

Persisted version.

expected: SchemaVersion

Version this build supports.

Implementations

impl ApplyError

pub fn io_at(path: impl Into<PathBuf>, source: Error) -> Self

Construct an ApplyError::Io tagged with the path the operation was targeting.

Trait Implementations

impl Debug for ApplyError

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

Formats the value using the given formatter.

impl Display for ApplyError

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

Formats the value using the given formatter.

impl Error for ApplyError

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<ApplyError> for Error

fn from(source: ApplyError) -> Self

Converts to this type from the input type.

impl From<ApplyError> for IndexError

fn from(err: ApplyError) -> Self

Converts to this type from the input type.

impl From<ApplyError> for VerifyError

fn from(err: ApplyError) -> Self

Converts to this type from the input type.

impl From<Error> for ApplyError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for ApplyError

fn from(source: ParseError) -> Self

Converts to this type from the input type.