Skip to main content

Chunk

Enum Chunk 

Source
#[non_exhaustive]
pub enum Chunk { FileHeader(FileHeader), ApplyOption(ApplyOption), ApplyFreeSpace(ApplyFreeSpace), AddDirectory(AddDirectory), DeleteDirectory(DeleteDirectory), Sqpk(SqpkCommand), EndOfFile, }
Expand description

One top-level chunk parsed from a ZiPatch stream.

Each variant corresponds to a 4-byte ASCII wire tag. The tag dispatch table mirrors the C# reference in lib/FFXIVQuickLauncher/.../Patching/ZiPatch/Chunk/ZiPatchChunk.cs.

§Observed frequency

SE’s XIVARR+ patch files almost exclusively contain FHDR, APLY, and SQPK chunks. ADIR/DELD can theoretically appear and are implemented, but are rarely emitted in practice. APFS has never been observed in modern patches (the reference implementation treats it as a no-op). EOF_ is consumed by ZiPatchReader and is never yielded to the caller.

§Exhaustiveness

The enum is #[non_exhaustive]. Match arms should include a wildcard to remain forward-compatible as new chunk types are added.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

FileHeader(FileHeader)

FHDR — the first chunk in every patch file; carries version and per-version patch metadata. See FileHeader for the versioned body.

§

ApplyOption(ApplyOption)

APLY — sets or clears a boolean apply-time flag on the crate::ApplyContext (e.g. “ignore missing files”). See ApplyOption.

§

ApplyFreeSpace(ApplyFreeSpace)

APFS — free-space book-keeping emitted by old patcher tooling; treated as a no-op at apply time. See ApplyFreeSpace.

§

AddDirectory(AddDirectory)

ADIR — instructs the patcher to create a directory under the game install root. See AddDirectory.

§

DeleteDirectory(DeleteDirectory)

DELD — instructs the patcher to remove a directory under the game install root. See DeleteDirectory.

§

Sqpk(SqpkCommand)

SQPK — the workhorse chunk; wraps one of eight sub-commands that add, delete, expand, or replace SqPack data. See SqpkCommand.

§

EndOfFile

EOF_ — marks the clean end of the patch stream. ZiPatchReader consumes this chunk internally; it is never yielded to the caller.

Trait Implementations§

Source§

impl Apply for Chunk

Dispatch table for top-level chunk variants.

FileHeader, ApplyFreeSpace, and EndOfFile are metadata or structural chunks with no filesystem effect; they return Ok(()) immediately. All other variants delegate to their specific Apply implementation.

Source§

fn apply(&self, ctx: &mut ApplyContext) -> Result<()>

Apply this chunk to ctx. Read more
Source§

impl Clone for Chunk

Source§

fn clone(&self) -> Chunk

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Chunk

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Chunk

Source§

fn eq(&self, other: &Chunk) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Chunk

Source§

impl StructuralPartialEq for Chunk

Auto Trait Implementations§

§

impl Freeze for Chunk

§

impl RefUnwindSafe for Chunk

§

impl Send for Chunk

§

impl Sync for Chunk

§

impl Unpin for Chunk

§

impl UnsafeUnpin for Chunk

§

impl UnwindSafe for Chunk

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more