Break: add initial meta.json support

Cargo.toml

@@ -18,6 +18,7 @@ prost = "0.11.3"
 serde = { version = "1.0.148", features = ["derive"] }
 serde_bytes = "0.11.7"
 serde-pickle = "1.1.1"
+serde_json = "1.0.96"
 thiserror = "1.0.37"
 zip = { version = "0.6.3", default-features = false, features = ["deflate"] }
 

src/error.rs

@@ -2,18 +2,18 @@ use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum Error {
-    #[error("failed to open the ZIP-archive")]
+    #[error("failed to open the replay as a ZIP-archive")]
     OpenArchiveFailed(#[source] zip::result::ZipError),
 
-    #[error("failed to open the battle results entry in the replay archive")]
+    #[error("failed to open the entry in the replay archive")]
-    OpenBattleResultsFailed(#[source] zip::result::ZipError),
+    OpenEntryFailed(#[source] zip::result::ZipError),
 
-    #[error("failed to read the archive entry")]
+    #[error("failed to decode the Protocol Buffers encoded data")]
-    ReadEntryFailed(#[source] std::io::Error),
-
-    #[error("failed to decode")]
     DecodeFailed(#[source] prost::DecodeError),
 
     #[error("failed to un-pickle")]
     UnpickleFailed(#[source] serde_pickle::Error),
+
+    #[error("failed to decode JSON")]
+    JsonDecodeFailed(#[source] serde_json::Error),
 }

src/lib.rs

@@ -17,6 +17,9 @@ pub mod prelude;
 mod replay;
 mod result;
 
+pub use self::error::Error;
+pub use self::result::Result;
+
 #[cfg(doctest)]
 mod test_readme {
     macro_rules! external_doc_test {

src/models.rs

@@ -1,5 +1,7 @@
 mod battle_results;
 mod battle_results_dat;
+mod meta;
 
 pub use self::battle_results::*;
 pub use self::battle_results_dat::*;
+pub use self::meta::*;

src/models/battle_results_dat.rs

@@ -35,17 +35,13 @@ impl BattleResultsDat {
     pub fn from_reader(reader: impl Read) -> Result<Self> {
         serde_pickle::from_reader(reader, Default::default()).map_err(Error::UnpickleFailed)
     }
-
-    /// Decodes the battle results from the internal buffer.
-    pub fn decode_battle_results(&self) -> Result<BattleResults> {
-        BattleResults::decode(self.buffer.as_ref()).map_err(Error::DecodeFailed)
-    }
 }
 
 impl TryInto<BattleResults> for BattleResultsDat {
     type Error = Error;
 
+    /// Decodes the battle results from the internal buffer.
     fn try_into(self) -> Result<BattleResults> {
-        self.decode_battle_results()
+        BattleResults::decode(self.buffer.as_ref()).map_err(Error::DecodeFailed)
     }
 }

src/models/meta.rs

@@ -0,0 +1,28 @@
+use std::io::Read;
+
+use serde::Deserialize;
+
+use crate::error::Error;
+use crate::result::Result;
+
+/// The model for `meta.json`.
+#[derive(Deserialize)]
+pub struct Meta {
+    #[serde(rename = "playerName")]
+    pub player_name: String,
+
+    #[serde(rename = "arenaUniqueId")]
+    pub arena_unique_id: String,
+
+    #[serde(rename = "battleDuration")]
+    pub battle_duration_secs: f64,
+
+    #[serde(rename = "vehicleCompDescriptor")]
+    pub tank_id: u16,
+}
+
+impl Meta {
+    pub fn from_reader(reader: impl Read) -> Result<Self> {
+        serde_json::from_reader(reader).map_err(Error::JsonDecodeFailed)
+    }
+}

src/prelude.rs

@@ -1,4 +1,2 @@
-pub use crate::error::Error;
 pub use crate::models::*;
 pub use crate::replay::Replay;
-pub use crate::result::Result;

src/replay.rs

@@ -3,7 +3,7 @@ use std::io::{Read, Seek};
 use zip::ZipArchive;
 
 use crate::error::Error;
-use crate::models::{BattleResults, BattleResultsDat};
+use crate::models::{BattleResults, BattleResultsDat, Meta};
 use crate::result::Result;
 
 /// Opened (but not yet parsed) replay.
@@ -19,7 +19,7 @@ impl<R: Read + Seek> Replay<R> {
 
     /// Reads and parses the battle results from the replay.
     pub fn read_battle_results(&mut self) -> Result<BattleResults> {
-        self.read_battle_results_dat()?.decode_battle_results()
+        self.read_battle_results_dat()?.try_into()
     }
 
     /// Reads and parses the included `battle_results.dat`.
@@ -27,7 +27,15 @@ impl<R: Read + Seek> Replay<R> {
         let pickled_battle_results = self
             .0
             .by_name("battle_results.dat")
-            .map_err(Error::OpenBattleResultsFailed)?;
+            .map_err(Error::OpenEntryFailed)?;
         BattleResultsDat::from_reader(pickled_battle_results)
     }
+
+    pub fn read_meta(&mut self) -> Result<Meta> {
+        Meta::from_reader(
+            self.0
+                .by_name("meta.json")
+                .map_err(Error::OpenEntryFailed)?,
+        )
+    }
 }

tests/battle_results.rs

@@ -8,7 +8,7 @@ fn player_results_ok() -> Result<()> {
     let battle_results_dat = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?
         .read_battle_results_dat()?;
     assert_eq!(battle_results_dat.arena_unique_id, 1661909200500084);
-    let battle_results = battle_results_dat.decode_battle_results()?;
+    let battle_results: BattleResults = battle_results_dat.try_into()?;
 
     let snak_the_ripper_info = &battle_results.player_results[3].info;
     assert_eq!(snak_the_ripper_info.base_xp, 929);

tests/meta.rs

@@ -0,0 +1,16 @@
+use std::fs::File;
+
+use anyhow::Result;
+use wotbreplay_parser::prelude::*;
+
+#[test]
+fn meta_ok() -> Result<()> {
+    let meta = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?.read_meta()?;
+
+    assert_eq!(meta.player_name, "zeekrab");
+    assert_eq!(meta.arena_unique_id, "1661909200500084");
+    assert_eq!(meta.battle_duration_secs, 164.08485);
+    assert_eq!(meta.tank_id, 26657);
+
+    Ok(())
+}