Struct DecodeableExtraData 

pub struct DecodeableExtraData<'a> { /* private fields */ }

Additional context data for Decodeable::decode() operations.

This structure provides optional configuration and metadata that decoders may need to properly interpret binary data. Different file types use different subsets of these fields.

Field Categories

• Configuration toggles: Control decoder behavior (lazy loading, encryption status, etc.)
• OnDisk-related data: File location and timestamp information
• Table-related data: Database table-specific context
• Image-related data: Image format detection flags
• General-purpose data: Game info, file names, sizes

Usage

use rpfm_lib::files::DecodeableExtraData;

// For decoding a DB table
let extra_data = DecodeableExtraData::default()
    .set_schema(Some(&schema))
    .set_game_info(Some(&game_info))
    .set_table_name(Some("units_tables"))
    .set_return_incomplete(true);

Required Fields by Type

• DB Tables: Require schema and optionally table_name for fragments
• Containers (PackFiles): Use lazy_load, disk_file_path, disk_file_offset
• Images: Use is_dds to enable DDS-specific decoding
• Generic files: May use game_info, file_name, data_size

For specific requirements, consult each file type’s documentation.

Implementations

impl<'a> DecodeableExtraData<'a>

pub fn lazy_load(&self) -> &bool

Enable lazy loading for container files.

When true, Container implementors will defer loading file data until accessed, storing only metadata initially. This reduces memory usage for large containers.

pub fn is_encrypted(&self) -> &bool

Indicates whether the source data was encrypted.

This is informational only - data reaching decode functions should already be decrypted. Used for metadata tracking and logging.

pub fn return_incomplete(&self) -> &bool

Allow returning partial data on decode errors (DB tables only).

When true, table decoders will return successfully decoded rows even if later rows fail to decode. When false, any decode error fails the entire operation.

pub fn schema(&self) -> &Option<&'a Schema>

Schema definition for decoding DB tables and Loc files.

Required for decoding database tables, as the schema defines the table structure, column types, and versioning information.

pub fn disk_file_path(&self) -> &Option<&'a str>

Absolute path to the file on disk.

Used by lazy-loading containers to know where to read data from when needed. Should be None for in-memory data.

pub fn disk_file_offset(&self) -> &u64

Byte offset within the disk file where this file’s data begins.

Used for files embedded within larger containers (e.g., individual files in a PackFile). Set to 0 for standalone files.

pub fn timestamp(&self) -> &u64

File modification timestamp (Unix epoch seconds).

Preserved from the original file for metadata tracking.

pub fn table_name(&self) -> &Option<&'a str>

Name of the table (without extension or path).

Used when decoding table fragments that don’t have the full path context. For example, when decoding a table from a loose file or unnamed buffer.

pub fn is_dds(&self) -> &bool

Flag indicating the image is in DDS (DirectDraw Surface) format.

When true, enables DDS-specific decoding and conversion to PNG for display.

pub fn game_info(&self) -> &Option<&'a GameInfo>

Complete game information context.

Provides game-specific settings, version info, and feature flags that may affect decoding behavior (e.g., format variations between game versions).

pub fn file_name(&self) -> &Option<&'a str>

Original filename (with extension).

Used for file type detection, logging, and error messages.

pub fn data_size(&self) -> &u64

Total size of the file data in bytes.

May differ from buffer size if dealing with partial data or compressed streams.

pub fn skip_path_cache_generation(&self) -> &bool

Skip automatic path cache generation for containers.

When true, container decoders won’t build the lowercase path cache automatically. You must manually call Container::paths_cache_generate() after decoding or case-insensitive lookups will fail.

This is an optimization for bulk operations where you’ll rebuild the cache once at the end instead of incrementally.

impl<'a> DecodeableExtraData<'a>

pub fn set_lazy_load(&mut self, val: bool) -> &mut Self

Enable lazy loading for container files.

When true, Container implementors will defer loading file data until accessed, storing only metadata initially. This reduces memory usage for large containers.

pub fn set_is_encrypted(&mut self, val: bool) -> &mut Self

Indicates whether the source data was encrypted.

This is informational only - data reaching decode functions should already be decrypted. Used for metadata tracking and logging.

pub fn set_return_incomplete(&mut self, val: bool) -> &mut Self

Allow returning partial data on decode errors (DB tables only).

When true, table decoders will return successfully decoded rows even if later rows fail to decode. When false, any decode error fails the entire operation.

pub fn set_schema(&mut self, val: Option<&'a Schema>) -> &mut Self

Schema definition for decoding DB tables and Loc files.

Required for decoding database tables, as the schema defines the table structure, column types, and versioning information.

pub fn set_disk_file_path(&mut self, val: Option<&'a str>) -> &mut Self

Absolute path to the file on disk.

Used by lazy-loading containers to know where to read data from when needed. Should be None for in-memory data.

pub fn set_disk_file_offset(&mut self, val: u64) -> &mut Self

Byte offset within the disk file where this file’s data begins.

Used for files embedded within larger containers (e.g., individual files in a PackFile). Set to 0 for standalone files.

pub fn set_timestamp(&mut self, val: u64) -> &mut Self

File modification timestamp (Unix epoch seconds).

Preserved from the original file for metadata tracking.

pub fn set_table_name(&mut self, val: Option<&'a str>) -> &mut Self

Name of the table (without extension or path).

Used when decoding table fragments that don’t have the full path context. For example, when decoding a table from a loose file or unnamed buffer.

pub fn set_is_dds(&mut self, val: bool) -> &mut Self

Flag indicating the image is in DDS (DirectDraw Surface) format.

When true, enables DDS-specific decoding and conversion to PNG for display.

pub fn set_game_info(&mut self, val: Option<&'a GameInfo>) -> &mut Self

Complete game information context.

Provides game-specific settings, version info, and feature flags that may affect decoding behavior (e.g., format variations between game versions).

pub fn set_file_name(&mut self, val: Option<&'a str>) -> &mut Self

Original filename (with extension).

Used for file type detection, logging, and error messages.

pub fn set_data_size(&mut self, val: u64) -> &mut Self

Total size of the file data in bytes.

May differ from buffer size if dealing with partial data or compressed streams.

pub fn set_skip_path_cache_generation(&mut self, val: bool) -> &mut Self

Skip automatic path cache generation for containers.

When true, container decoders won’t build the lowercase path cache automatically. You must manually call Container::paths_cache_generate() after decoding or case-insensitive lookups will fail.

This is an optimization for bulk operations where you’ll rebuild the cache once at the end instead of incrementally.

Trait Implementations

impl<'a> Clone for DecodeableExtraData<'a>

fn clone(&self) -> DecodeableExtraData<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DecodeableExtraData<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DecodeableExtraData<'a>

fn default() -> DecodeableExtraData<'a>

Returns the “default value” for a type.