Skip to main content

SqpkTargetInfo

Struct SqpkTargetInfo 

Source
pub struct SqpkTargetInfo {
    pub platform_id: u16,
    pub region: i16,
    pub is_debug: bool,
    pub version: u16,
    pub deleted_data_size: u64,
    pub seek_count: u64,
}
Expand description

SQPK T command body: declares the target platform, region, and patch statistics for all subsequent operations in a patch file.

A real FFXIV patch file begins with a T command before any write operations, so the platform declared here is in effect for all subsequent path resolution. The apply layer updates crate::apply::ApplyContext::platform from platform_id and otherwise ignores the remaining fields.

§Wire format

Important: Most fields are big-endian (the struct-level #[br(big)] default), but deleted_data_size and seek_count are little-endian. This endian anomaly is present in the original C# implementation (SqpkTargetInfo.cs) and must be preserved exactly.

┌───────────────────────────────────────────────────────────────────┐
│ <reserved>        : [u8; 3]  (always zero)                        │  bytes 0–2
│ platform_id       : u16 BE   0=Win32, 1=PS3, 2=PS4               │  bytes 3–4
│ region            : i16 BE   -1=Global                            │  bytes 5–6
│ is_debug          : i16 BE   0=release, nonzero=debug             │  bytes 7–8
│ version           : u16 BE   client version                        │  bytes 9–10
│ deleted_data_size : u64 LE   ← little-endian anomaly              │  bytes 11–18
│ seek_count        : u64 LE   ← little-endian anomaly              │  bytes 19–26
│ <trailing padding>            bounded by the body slice            │
└───────────────────────────────────────────────────────────────────┘

§Reference

See SqpkTargetInfo.cs in the XIVLauncher reference implementation.

§Errors

Parsing returns crate::ZiPatchError::BinrwError if the body is too short to contain all required fields.

Fields§

§platform_id: u16

Target platform identifier.

ValuePlatformPath suffix
0Windows / PCwin32
1PlayStation 3ps3
2PlayStation 4ps4
otherUnknownfalls back to win32

Preceded by 3 bytes of reserved/padding in the wire format. Encoded as a big-endian u16.

§region: i16

Region code for the patch target.

-1 means Global (the standard international release). Other values are region-specific builds (e.g. Chinese or Korean clients). Encoded as a big-endian i16.

§is_debug: bool

true when the patch targets a debug build of the game client.

Parsed from a big-endian i16: zero → false, any nonzero → true. Debug patches are not distributed through normal update channels.

§version: u16

Target client version number. Informational; not used for path resolution.

Encoded as a big-endian u16.

§deleted_data_size: u64

Total bytes freed (deleted) across the entire patch.

Used by patch manager UIs for progress estimation. Little-endian despite the struct-level #[br(big)] default — see the wire-format note above.

§seek_count: u64

Total number of seek operations the patcher is expected to perform.

Used by patch manager UIs for progress estimation. Little-endian despite the struct-level #[br(big)] default — see the wire-format note above.

Trait Implementations§

Source§

impl BinRead for SqpkTargetInfo

Source§

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options(). Read more
Source§

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments. Read more
Source§

fn read<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments. Read more
Source§

fn read_be<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order. Read more
Source§

fn read_le<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order. Read more
Source§

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order. Read more
Source§

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments. Read more
Source§

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments. Read more
Source§

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments. Read more
Source§

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments. Read more
Source§

impl Clone for SqpkTargetInfo

Source§

fn clone(&self) -> SqpkTargetInfo

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 SqpkTargetInfo

Source§

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

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

impl PartialEq for SqpkTargetInfo

Source§

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

Source§

const ENDIAN: EndianKind

The endianness of the type.
Source§

impl Eq for SqpkTargetInfo

Source§

impl StructuralPartialEq for SqpkTargetInfo

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