Skip to main content

SqpkFileOperation

Enum SqpkFileOperation 

Source
pub enum SqpkFileOperation {
    AddFile,
    RemoveAll,
    DeleteFile,
    MakeDirTree,
}
Expand description

Operation byte of a SQPK F command; selects what the command does to the game install tree.

Encoded as a single ASCII byte in the wire format: b'A'AddFile, b'R'RemoveAll, b'D'DeleteFile, b'M'MakeDirTree. Any other byte is rejected with ZiPatchError::UnknownFileOperation.

See SqpkFile.cs in the XIVLauncher reference implementation.

Variants§

§

AddFile

A — write the inline compressed-block payload into a file under the game install root, creating it (or overwriting it) as needed.

Parent directories are created automatically. If file_offset is zero, the target file is truncated to zero before writing (full replacement); if file_offset is non-zero, only the covered range is overwritten.

§

RemoveAll

R — delete all files in the expansion folder (sqpack/<expansion>/ and movie/<expansion>/) that are not on the keep-list.

Kept unconditionally: .var files and 00000.bk200003.bk2. Files 00004.bk2 and beyond are deleted. expansion_id selects the target expansion folder.

§

DeleteFile

D — delete a single file at the path given by SqpkFile::path.

§

MakeDirTree

M — create the directory tree at SqpkFile::path (equivalent to std::fs::create_dir_all). Idempotent.

Trait Implementations§

Source§

impl Clone for SqpkFileOperation

Source§

fn clone(&self) -> SqpkFileOperation

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 SqpkFileOperation

Source§

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

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

impl PartialEq for SqpkFileOperation

Source§

fn eq(&self, other: &SqpkFileOperation) -> 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 Copy for SqpkFileOperation

Source§

impl Eq for SqpkFileOperation

Source§

impl StructuralPartialEq for SqpkFileOperation

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