Struct EncodeableExtraData 

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

Additional context data for Encodeable::encode() operations.

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

Field Categories

• Configuration toggles: Control encoder behavior (test mode, date handling, GUIDs)
• Optional config data: Game info, compression settings

Usage

use rpfm_lib::files::EncodeableExtraData;
use rpfm_lib::compression::CompressionFormat;

// For encoding a DB table with GUID
let extra_data = EncodeableExtraData::default()
    .set_game_info(Some(&game_info))
    .set_table_has_guid(true)
    .set_regenerate_table_guid(true);

// For encoding with compression
let extra_data = EncodeableExtraData::default()
    .set_compression_format(CompressionFormat::Lz4)
    .set_game_info(Some(&game_info));

Common Configurations

• DB Tables: Use table_has_guid and regenerate_table_guid to control GUID handling
• Containers (PackFiles): Use compression_format to enable compression
• Testing: Use test_mode and nullify_dates for deterministic output
• ESF Files: Use disable_compression for nested encoding

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

Implementations

impl<'a> EncodeableExtraData<'a>

pub fn test_mode(&self) -> &bool

Enable test mode for deterministic output.

When true, encoders may skip randomization or use fixed values for fields that would normally vary (like auto-generated IDs), making output reproducible for testing purposes.

pub fn nullify_dates(&self) -> &bool

Zero out all date and timestamp fields.

When true, any date or timestamp fields are written as 0 instead of their actual values. Used in conjunction with test_mode for reproducible output, or when dates should be reset.

pub fn table_has_guid(&self) -> &bool

Include a GUID in the DB table header.

When true, table encoders will write a GUID (Globally Unique Identifier) in the table header. Required for Shogun 2 and newer games. Must be false for Empire and Napoleon, as including a GUID crashes those games on load.

pub fn regenerate_table_guid(&self) -> &bool

Generate a new GUID for the table instead of preserving the existing one.

When true, a fresh random GUID is generated. When false, the existing GUID (if any) is preserved. Only meaningful when table_has_guid is also true.

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

Complete game information context.

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

pub fn compression_format(&self) -> &CompressionFormat

Compression format to use when writing files.

Specifies which compression algorithm to apply. Common formats include:

• CompressionFormat::None: No compression
• CompressionFormat::Lz4: Fast compression
• CompressionFormat::Zstd: Modern compression (best ratio)
• CompressionFormat::Lzma1: Legacy compression (older games)

The game info may override this based on what the target game supports.

pub fn disable_compression(&self) -> &bool

Disable compression for nested encoding operations.

When true, prevents compression even if compression_format is set. Used for ESF (Empire Save File) encoding where the outer container handles compression and inner structures should remain uncompressed to avoid double-compression.

impl<'a> EncodeableExtraData<'a>

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

Enable test mode for deterministic output.

When true, encoders may skip randomization or use fixed values for fields that would normally vary (like auto-generated IDs), making output reproducible for testing purposes.

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

Zero out all date and timestamp fields.

When true, any date or timestamp fields are written as 0 instead of their actual values. Used in conjunction with test_mode for reproducible output, or when dates should be reset.

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

Include a GUID in the DB table header.

When true, table encoders will write a GUID (Globally Unique Identifier) in the table header. Required for Shogun 2 and newer games. Must be false for Empire and Napoleon, as including a GUID crashes those games on load.

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

Generate a new GUID for the table instead of preserving the existing one.

When true, a fresh random GUID is generated. When false, the existing GUID (if any) is preserved. Only meaningful when table_has_guid is also true.

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 encoding behavior (e.g., format variations between game versions).

pub fn set_compression_format(&mut self, val: CompressionFormat) -> &mut Self

Compression format to use when writing files.

Specifies which compression algorithm to apply. Common formats include:

• CompressionFormat::None: No compression
• CompressionFormat::Lz4: Fast compression
• CompressionFormat::Zstd: Modern compression (best ratio)
• CompressionFormat::Lzma1: Legacy compression (older games)

The game info may override this based on what the target game supports.

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

Disable compression for nested encoding operations.

When true, prevents compression even if compression_format is set. Used for ESF (Empire Save File) encoding where the outer container handles compression and inner structures should remain uncompressed to avoid double-compression.

impl<'a> EncodeableExtraData<'a>

pub fn new_from_game_info(game_info: &'a GameInfo) -> Self

This functions generates an EncodeableExtraData for a specific game.

pub fn new_from_game_info_and_settings( game_info: &'a GameInfo, cf: CompressionFormat, disable_regen_table_guid: bool, ) -> EncodeableExtraData<'a>

This functions generates an EncodeableExtraData for a specific game and settings.

Trait Implementations

impl<'a> Clone for EncodeableExtraData<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Default for EncodeableExtraData<'a>

fn default() -> EncodeableExtraData<'a>

Returns the “default value” for a type.