Struct IniFileSystem 

pub struct IniFileSystem { /* private fields */ }

A hierarchical file system of IniFile.

example usage:

 use std::path::PathBuf;
 use rpkg_rs::misc::ini_file_system::IniFileSystem;

 let retail_path = PathBuf::from("Path to retail folder");
 let thumbs_path = retail_path.join("thumbs.dat");

 let thumbs = IniFileSystem::from(&thumbs_path.as_path())?;

 let app_options = &thumbs.root()?;

 if let (Some(proj_path), Some(runtime_path)) = (app_options.get("PROJECT_PATH"), app_options.get("RUNTIME_PATH")) {
    println!("Project path: {}", proj_path);
    println!("Runtime path: {}", runtime_path);
 }

Implementations

impl IniFileSystem

pub fn new(ini_file: IniFile) -> Self

pub fn from_path( root_file: impl AsRef<Path>, xtea_config: XteaConfig, ) -> Result<Self, IniFileError>

Loads an IniFileSystem from a root file on disk.

The file is read from root_file and decrypted using the provided XteaConfig, parsed as an IniFile, and any !include directives are resolved recursively relative to the root file’s parent directory.

Examples found in repository

examples/mount_ini_system.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let ini = glacier_ini::IniFileSystem::from_path("./Retail/thumbs.dat", XteaConfig::Knt)?;
    println!("{:?}", ini);
    Ok(())
}

pub fn write_to_folder<P: AsRef<Path>>( &self, path: P, xtea_config: XteaConfig, ) -> Result<(), IniFileError>

Writes the entire IniFileSystem to a folder on disk.

The root file and all included files are written recursively, preserving their relative paths. Output is encrypted with the provided XteaConfig.

If path points to a file, its parent directory is used as the export root. If you don’t want multiple included ini files in the export path you should consider using the normalize function first first

pub fn normalize(&mut self)

Normalizes the IniFileSystem by merging all included files into the root file.

Sections and console commands from included files are applied breadth-first. When an option already exists in the root, later values overwrite earlier ones. Included files are removed from the hierarchy as part of normalization.

pub fn console_cmds(&self) -> Vec<String>

Retrieves all console commands from the IniFileSystem, including those from included files.

pub fn option( &self, key: impl Into<IniKey> + Clone, ) -> Result<String, IniFileError>

Retrieves the value of an option in a section from the IniFileSystem, including values from included files.

pub fn root(&self) -> &IniFile

Retrieves a reference to the root IniFile of the IniFileSystem.

pub fn root_mut(&mut self) -> &mut IniFile

Retrieves a reference to the root IniFile of the IniFileSystem.

Trait Implementations

impl Debug for IniFileSystem

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

Formats the value using the given formatter.