Struct SqpackFile 

pub struct SqpackFile {
    pub main_id: u16,
    pub sub_id: u16,
    pub file_id: u32,
}

Identifier of a SqPack file targeted by a SQPK command.

SqPack files live under <game_root>/sqpack/<expansion>/<main_id:02x><sub_id:04x>.<platform>.<kind>. The three fields together uniquely address one file on disk; see the apply::path module for how they are combined into filesystem paths.

Fields

main_id: u16

Category/repository identifier — the first two hex digits of the filename stem (e.g. 04 in 040100.win32.dat0).

Encoded as a big-endian u16 (2 bytes) in the wire format.

sub_id: u16

Sub-category identifier — the next four hex digits of the filename stem (e.g. 0100 in 040100.win32.dat0).

Encoded as a big-endian u16 (2 bytes). The high byte (sub_id >> 8) selects the expansion folder: 0 → ffxiv, 1 → ex1, 2 → ex2, etc.

file_id: u32

File index within the category, used to derive the numeric suffix:

• For .dat files: appended directly as the decimal N in .datN.
• For .index files: 0 produces no suffix (.index); 1 or higher appends the value directly (.index1, .index2, …).

Encoded as a big-endian u32 (4 bytes).

Trait Implementations

impl BinRead for SqpackFile

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

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.

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.

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.

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.

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.

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.

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.

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.

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.

impl Clone for SqpackFile

fn clone(&self) -> SqpackFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqpackFile

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

Formats the value using the given formatter.

impl Hash for SqpackFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SqpackFile

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ReadEndian for SqpackFile

const ENDIAN: EndianKind

The endianness of the type.

impl Eq for SqpackFile

impl StructuralPartialEq for SqpackFile