Struct ApplySession 

pub struct ApplySession { /* private fields */ }

Active apply-time runtime state.

Holds the mutable scratch and bookkeeping a running apply needs: open file-handle cache, memoised directory and path caches, the reusable DEFLATE decompressor, and per-chunk progress counters.

Implementations

impl ApplySession

pub fn apply_patch<R: Read>( &mut self, reader: ZiPatchReader<R>, ) -> ApplyResult<()>

Iterate every chunk in reader and apply each one to this session.

This is the primary high-level entry point for applying a patch. It drives the ZiPatchReader to completion, dispatching each yielded Chunk through the apply layer in stream order.

Chunks must be applied in order — the ZiPatch format is a sequential log and later chunks may depend on filesystem state produced by earlier ones.

Errors

Stops at the first parse or apply error and returns it immediately. Any filesystem changes already applied by earlier chunks are not rolled back.

pub fn resume_apply_patch<R: Read + Seek>( &mut self, reader: ZiPatchReader<R>, from: Option<&SequentialCheckpoint>, ) -> ApplyResult<SequentialCheckpoint>

Resume a previously interrupted apply from a SequentialCheckpoint.

See ApplyConfig::resume_apply_patch for the conceptual overview and the resume contract.

Errors

Same vocabulary as Self::apply_patch, plus ApplyError::SchemaVersionMismatch when from.schema_version does not equal SequentialCheckpoint::CURRENT_SCHEMA_VERSION.

impl ApplySession

pub fn config(&self) -> &ApplyConfig

Returns the underlying ApplyConfig.

pub fn game_path(&self) -> &Path

Returns the game installation directory.

pub fn platform(&self) -> Platform

Returns the current target platform.

pub fn ignore_missing(&self) -> bool

Returns whether missing files are silently ignored.

pub fn ignore_old_mismatch(&self) -> bool

Returns whether old-data mismatches are silently ignored.

pub fn sync_all(&mut self) -> Result<()>

Flush every cached BufWriter, then sync_all the underlying handles.

pub fn flush(&mut self) -> Result<()>

Flush every buffered write through to the underlying Vfs handle.

Trait Implementations

impl Debug for ApplySession

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

Formats the value using the given formatter.