Skip to main content

SqpkCommand

Enum SqpkCommand 

Source
pub enum SqpkCommand {
    AddData(Box<SqpkAddData>),
    DeleteData(SqpkDeleteData),
    ExpandData(SqpkExpandData),
    Header(SqpkHeader),
    TargetInfo(SqpkTargetInfo),
    File(Box<SqpkFile>),
    Index(SqpkIndex),
    PatchInfo(SqpkPatchInfo),
}
Expand description

Sub-command of a SQPK chunk; the variant is selected by the command byte.

Each variant wraps the parsed body of its corresponding sub-command. AddData and File are heap-allocated to keep the enum from inflating the stack when used in iterators — SqpkAddData can carry a large inline data Vec, and SqpkFile carries both a path and a Vec of compressed blocks.

Two variants — Index and PatchInfo — carry metadata consumed by the indexed ZiPatch reader (not yet implemented) and have no direct filesystem effect; their SqpkCommand::apply arms return Ok(()) immediately.

Unknown sub-command bytes are never silently ignored: they surface as ParseError::UnknownSqpkCommand during parsing.

Variants§

§

AddData(Box<SqpkAddData>)

SQPK A — write a data payload into a .dat file at a block offset, then zero a trailing range of blocks. See SqpkAddData.

§

DeleteData(SqpkDeleteData)

SQPK D — overwrite a contiguous block range with empty-block markers, logically freeing those blocks in the SqPack archive. See SqpkDeleteData.

§

ExpandData(SqpkExpandData)

SQPK E — extend a .dat file into previously unallocated space by writing empty-block markers. See SqpkExpandData.

§

Header(SqpkHeader)

SQPK H — write a 1024-byte SqPack header into a .dat or .index file at offset 0 (version header) or 1024 (secondary header). See SqpkHeader.

§

TargetInfo(SqpkTargetInfo)

SQPK T — declares the target platform and region for all subsequent path-resolution operations in this patch. See SqpkTargetInfo.

§

File(Box<SqpkFile>)

SQPK F — file-level operation: add a file from inline block payloads, delete a file, remove all files in an expansion folder, or create a directory tree. See SqpkFile and SqpkFileOperation.

§

Index(SqpkIndex)

SQPK I — add or remove a single SqPack index entry. Carries the index hash and block location for use by the indexed ZiPatch reader; has no direct apply effect. See SqpkIndex.

§

PatchInfo(SqpkPatchInfo)

SQPK X — patch install info: status, version, and declared post-patch install size. Metadata only; not applied to the filesystem. See SqpkPatchInfo.

Implementations§

Source§

impl SqpkCommand

Source

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

Apply this SQPK sub-command to ctx.

Trait Implementations§

Source§

impl Debug for SqpkCommand

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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