Skip to main content

Chunk

Enum Chunk 

Source
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.

§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 and is treated as a no-op. EOF_ is consumed by ZiPatchReader and is never yielded to the caller.

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::ApplyConfig (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.

Implementations§

Source§

impl Chunk

Source

pub fn apply(&self, session: &mut ApplySession) -> Result<()>

Apply this chunk to session.

Trait Implementations§

Source§

impl Debug for Chunk

Source§

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

Formats the value using the given formatter. Read more

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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