Enum PFHVersion 

pub enum PFHVersion {
    PFH6,
    PFH5,
    PFH4,
    PFH3,
    PFH2,
    PFH0,
}

PackFile format version.

Identifies the internal format version of a PackFile, which determines its structure, capabilities, and which games can read it.

Version History

Each variant represents a different format evolution in Total War’s PackFile system. Newer versions generally support more features but may not be readable by older games.

Compatibility

Games can typically read their own version and sometimes older versions, but cannot read newer versions. For maximum compatibility when creating mods, use the version matching the target game.

Variants

PFH6

Used in Troy (v1.3.0+).

PFH5

Used in Warhammer 2, Warhammer 3, Three Kingdoms, Troy (pre-1.3.0), Pharaoh, Pharaoh Dynasties, Arena.

PFH4

Used in Warhammer 1, Attila, Rome 2, Thrones of Britannia.

PFH3

Used in Shogun 2.

PFH2

Used in Shogun 2 before patch 15 (Fall of the Samurai expansion).

PFH0

Used in Napoleon and Empire.

Implementations

impl PFHVersion

Implementation of PFHVersion.

pub fn value(&self) -> &str

Returns the 4-byte preamble string for this format version.

This is the “magic number” that appears at offset 0x00 in the PackFile header to identify its format version.

Returns

A 4-character string like "PFH6", "PFH5", etc.

Example

use rpfm_lib::games::pfh_version::PFHVersion;

assert_eq!(PFHVersion::PFH6.value(), "PFH6");
assert_eq!(PFHVersion::PFH5.value(), "PFH5");
assert_eq!(PFHVersion::PFH0.value(), "PFH0");

pub fn version(value: &str) -> Result<Self>

Parses a preamble string into a format version.

Converts a 4-byte preamble read from a PackFile header into the corresponding PFHVersion enum variant.

Arguments

• value - The 4-character preamble string (e.g., "PFH5")

Returns

Returns the matching PFHVersion, or an error if the preamble is not recognized.

Errors

Returns RLibError::UnknownPFHVersion if the preamble doesn’t match any known version.

Example

use rpfm_lib::games::pfh_version::PFHVersion;

let version = PFHVersion::version("PFH5").unwrap();
assert_eq!(version, PFHVersion::PFH5);

// Invalid preamble returns error
assert!(PFHVersion::version("PFH9").is_err());

Trait Implementations

impl Clone for PFHVersion

fn clone(&self) -> PFHVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PFHVersion

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

Formats the value using the given formatter.

impl Default for PFHVersion

Implementation of trait Default for PFHVersion.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PFHVersion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PFHVersion

Display implementation of PFHVersion.

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

Formats the value using the given formatter.

impl PartialEq for PFHVersion

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PFHVersion

impl Eq for PFHVersion

impl StructuralPartialEq for PFHVersion