Struct ApplyOption 

pub struct ApplyOption {
    pub kind: ApplyOptionKind,
    pub value: bool,
}

APLY chunk: sets or clears a boolean flag on the crate::ApplyContext.

Each APLY chunk carries one flag selector (ApplyOptionKind) and one boolean value. When applied, the corresponding field on crate::ApplyContext is updated. In all FFXIV patch files observed by the XIVLauncher project, both flags are set to false — the chunk exists to allow SE’s tooling to override the defaults without hard-coding them.

See lib/FFXIVQuickLauncher/.../Chunk/ApplyOptionChunk.cs.

Wire format

[kind: u32 BE] [padding: 4 bytes] [value: u32 BE, non-zero = true]

The 4-byte padding between kind and value is always 0x00000004 in observed files, but the reference implementation discards it without checking.

Errors

Parsing fails with crate::ZiPatchError::BinrwError if:

• the kind field is not 1 or 2 (unrecognised option), or
• the body is too short to contain all three 4-byte fields.

Fields

kind: ApplyOptionKind

Which crate::ApplyContext flag this chunk targets.

Encoded as a u32 big-endian on the wire; mapped to ApplyOptionKind during parsing.

value: bool

New value for the targeted flag.

On the wire: a u32 BE preceded by 4 bytes of padding (pad_before = 4). Any non-zero value is treated as true.

Trait Implementations

impl Apply for ApplyOption

Updates ApplyContext ignore-flags from the chunk payload.

ApplyOption chunks are embedded in the patch stream to toggle ApplyContext::ignore_missing and ApplyContext::ignore_old_mismatch at specific points during apply. Applying this chunk mutates ctx in place; no filesystem I/O is performed.

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

Apply this chunk to ctx.

impl BinRead for ApplyOption

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 ApplyOption

fn clone(&self) -> ApplyOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApplyOption

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

Formats the value using the given formatter.

impl PartialEq for ApplyOption

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

const ENDIAN: EndianKind

The endianness of the type.

impl Eq for ApplyOption

impl StructuralPartialEq for ApplyOption