Struct genie_lang::LangFile

pub struct LangFile { /* fields omitted */ }

A file containing language strings.

Methods

impl LangFile

pub fn from_dll(input: impl Read) -> Result<Self, LoadError>

Read a language file from a .DLL.

This eagerly loads all the strings into memory.

pub fn from_ini(input: impl Read) -> Result<Self, LoadError>

Read a language file from a .INI file, like the ones used by Voobly and the aoc-language-ini mod.

This eagerly loads all the strings into memory. At this time, the encoding of the language.ini file is assumed to be Windows codepage 1252.

pub fn from_keyval(input: impl Read) -> Result<Self, LoadError>

Read a language file from an HD Edition-style key-value file.

This eagerly loads all the strings into memory.

pub fn get(&self, index: u32) -> Option<&str>

Get a string by its numeric index.

pub fn get_named(&self, name: &str) -> Option<&str>

Get a string by name (HD Edition only).

pub fn set(&mut self, index: u32, value: impl Into<String>)

Set a string at the given numeric index.

pub fn set_named(&mut self, name: &str, value: impl Into<String>)

Set a string by name.

pub fn del(&mut self, index: u32) -> Option<String>

Delete a string by its numeric index.

Returns the string if it previously existed.

pub fn del_named(&mut self, name: &str) -> Option<String>

Delete a string by name.

Returns the string if it previously existed.

pub fn iter(&self) -> impl Iterator<Item = (u32, &str)>

Get an iterator over all the numerically indexed strings.

pub fn iter_named(&self) -> impl Iterator<Item = (&str, &str)>

Get an iterator over all the named strings.

pub fn write_to_ini<W: Write>(&self, output: &mut W) -> Result<()>

pub fn write_to_keyval<W: Write>(&self, output: &mut W) -> Result<()>

Trait Implementations

impl Default for LangFile

fn default() -> LangFile

Returns the "default value" for a type.

impl Debug for LangFile

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

Formats the value using the given formatter.