Opt: add the docstrings and TODO

This commit is contained in:
eigenein committed 2023-04-20 01:24:07 +02:00
1 parent fb9beb5ecc
commit e0ce6a22b1
2 files changed
+5

No files matched your search

+2
View File
@@ -15,6 +15,8 @@ impl BattleResults {
}
/// Parsed battle results.
///
/// TODO: 150[0].21[0].8[0].801[0].unsigned is arena end time.
#[derive(Message, Serialize)]
pub struct BattleResults {
/// Battle timestamp.
+3
View File
@@ -21,6 +21,9 @@ pub struct BattleResultsDat(
impl BattleResultsDat {
/// Parses the pickled structure from the reader which contains `battle_results.dat`.
///
/// It can be used either on the `battle_results.dat` for a replay archive,
/// or directly on `**/DAVAProject/battle_results/*/*_full.dat`.
pub fn from_reader(reader: impl Read) -> Result<Self> {
serde_pickle::from_reader(reader, Default::default()).map_err(Error::UnpickleFailed)
}