Enum IndexError 

#[non_exhaustive]
pub enum IndexError {
    Parse(ParseError),
    Io {
        path: Option<PathBuf>,
        source: Error,
    },
    UnsupportedPlatform(u16),
    Cancelled,
    SourceUnavailable {
        target_offset: u64,
        length: u32,
    },
    PatchSourceTooShort {
        offset: u64,
        requested: usize,
    },
    PatchIndexOutOfRange {
        patch: PatchIndex,
        count: usize,
    },
    UnsafeTargetPath(String),
    SchemaVersionMismatch {
        kind: &'static str,
        found: SchemaVersion,
        expected: SchemaVersion,
    },
    DuplicatePatch {
        name: String,
    },
    InvalidField {
        context: &'static str,
    },
}

Failures produced by the indexed pipeline (crate::index).

#[non_exhaustive]: the indexed pipeline is the youngest layer and has the highest expected churn in surfaced failure modes.

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 plan builder was scanning chunks.

Io

An I/O failure during plan building, source reads, or indexed apply.

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

Indexed apply was cancelled by an observer or checkpoint signal.

SourceUnavailable

An indexed-apply plan referenced a region whose source bytes are not reachable from the current applier.

Fields

target_offset: u64

Target-file offset of the unavailable region.

length: u32

Length in bytes of the unavailable region.

PatchSourceTooShort

A crate::index::PatchSource::read call could not fill the requested buffer.

Fields

offset: u64

Patch-file offset at which the read was attempted.

requested: usize

Number of bytes the caller asked for.

PatchIndexOutOfRange

A crate::index::PatchSource::read call asked for a patch index outside the source’s configured chain.

Fields

patch: PatchIndex

Index that was requested.

count: usize

Total number of patches the source was constructed with.

UnsafeTargetPath(String)

An indexed-plan target or filesystem-op carried a path that escapes the install root.

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.

DuplicatePatch

Two patches in the same chain shared a name.

Fields

name: String

The patch name that was added twice.

InvalidField

A field value failed a builder invariant.

Fields

context: &'static str

Human-readable description of which field was invalid and why.

Trait Implementations

impl Debug for IndexError

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

Formats the value using the given formatter.

impl Display for IndexError

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

Formats the value using the given formatter.

impl Error for IndexError

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 IndexError

fn from(err: ApplyError) -> Self

Converts to this type from the input type.

impl From<Error> for IndexError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<IndexError> for Error

fn from(source: IndexError) -> Self

Converts to this type from the input type.

impl From<ParseError> for IndexError

fn from(source: ParseError) -> Self

Converts to this type from the input type.