Struct PackTranslation 

pub struct PackTranslation { /* private fields */ }

Translation data for an entire pack.

Contains all translatable strings from a pack along with their translations and metadata about translation status.

Persistence

This struct is serialized to JSON files for storage and can be loaded back when continuing translation work.

Parent Translations

When a pack has dependencies, translations from parent mods are also loaded and used for auto-translation, ensuring consistent terminology across dependent mods.

Implementations

impl PackTranslation

pub fn language(&self) -> &String

Target language code for translations (e.g., “es”, “de”, “fr”).

pub fn pack_name(&self) -> &String

Name of the pack these translations belong to.

pub fn translations(&self) -> &HashMap<String, Translation>

Map of Loc keys to their translation data.

Keys are the original Loc entry keys from the pack.

impl PackTranslation

pub fn language_mut(&mut self) -> &mut String

Target language code for translations (e.g., “es”, “de”, “fr”).

pub fn pack_name_mut(&mut self) -> &mut String

Name of the pack these translations belong to.

pub fn translations_mut(&mut self) -> &mut HashMap<String, Translation>

Map of Loc keys to their translation data.

Keys are the original Loc entry keys from the pack.

impl PackTranslation

pub fn set_language(&mut self, val: String) -> &mut Self

Target language code for translations (e.g., “es”, “de”, “fr”).

pub fn set_pack_name(&mut self, val: String) -> &mut Self

Name of the pack these translations belong to.

pub fn set_translations( &mut self, val: HashMap<String, Translation>, ) -> &mut Self

Map of Loc keys to their translation data.

Keys are the original Loc entry keys from the pack.

impl PackTranslation

pub fn new( paths: &[PathBuf], pack: &Pack, game_key: &str, language: &str, dependencies: &Dependencies, base_english: &HashMap<String, String>, base_local_fixes: &HashMap<String, String>, ) -> Result<Self>

pub fn sort_and_merge_locs_for_translation(locs: &mut [&RFile]) -> Result<Loc>

pub fn apply(&self, _pack: &mut Pack) -> Result<()>

This function applies a PackTranslation to a Pack.

pub fn load( paths: &[PathBuf], pack_name: &str, game_key: &str, language: &str, ) -> Result<Self>

This function loads a PackTranslation to memory from either a local json file, or a remote one.

pub fn save(&mut self, path: &Path, game_key: &str) -> Result<()>

This function saves a PackTranslation from memory to a .json file with the provided path.

pub fn definition() -> Definition

pub fn from_table(&mut self, table: &TableInMemory) -> Result<()>

pub fn to_table(&self) -> Result<TableInMemory>

Trait Implementations

impl Clone for PackTranslation

fn clone(&self) -> PackTranslation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackTranslation

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

Formats the value using the given formatter.

impl Default for PackTranslation

fn default() -> PackTranslation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PackTranslation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PackTranslation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.