redstrate/physis
1
Fork 0
mirror of https://github.com/redstrate/Physis.git synced 2025-06-07 23:27:45 +00:00
Code Activity

Improve the lackluster BootData documentation

Browse source
This commit is contained in:
Joshua Goins 2023-09-22 17:56:33 -04:00
parent 1343bcdca6
commit c41f17a126
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/bootdata.rs
View file

@ -6,10 +6,11 @@ use std::path::PathBuf;
use crate::patch::{apply_patch, PatchError}; use crate::patch::{apply_patch, PatchError};
/// Boot data for FFXIV. /// Represents the boot data for FFXIV, which is located under the "boot" directory.
pub struct BootData { pub struct BootData {
path: String, path: String,
/// The current version of the boot data, e.g. "2012.01.01.0000.0000".
pub version: String, pub version: String,
} }
@ -49,6 +50,7 @@ impl BootData {
} }
} }
/// Applies the patch to boot data and returns any errors it encounters. This function will not update the version in the BootData struct.
pub fn apply_patch(&self, patch_path: &str) -> Result<(), PatchError> { pub fn apply_patch(&self, patch_path: &str) -> Result<(), PatchError> {
apply_patch(&self.path, patch_path) apply_patch(&self.path, patch_path)
} }

2
src/lib.rs
View file

@ -9,7 +9,7 @@ pub mod gamedata;
/// Parsing game repositories, such as "ffxiv", "ex1" and their version information. /// Parsing game repositories, such as "ffxiv", "ex1" and their version information.
pub mod repository; pub mod repository;
/// Reading and writing the boot data repository. /// Handling and updating data in the "boot" directory, which contains the launcher files.
pub mod bootdata; pub mod bootdata;
/// Common methods and structures relating to the SqPack data format. /// Common methods and structures relating to the SqPack data format.