vault/lib.rs
1//! `vault` is a Company of Heroes 3 replay parser written with nom, and exposing Ruby bindings
2//! via magnus.
3//!
4//! Currently, this library is able to parse player, map, and chat message data, as well as various
5//! bits and pieces of basic replay information. It is not currently able to parse detailed command
6//! information
7//!
8//! To use, simply initialize an instance of `Replay` by using one of its parsing entrypoints:
9//!
10//! ```ignore
11//! fn main() {
12//! let data = include_bytes!("/path/to/replay.rec");
13//! let replay = vault::Replay::from_bytes(data);
14//! assert!(replay.is_ok())
15//! }
16//! ```
17
18mod command;
19pub mod command_data;
20mod command_type;
21mod data;
22mod errors;
23mod map;
24mod message;
25mod player;
26mod replay;
27
28pub use crate::command::Command;
29#[cfg(feature = "raw")]
30pub use crate::command::RawCommand;
31pub use crate::command_type::CommandType;
32pub use crate::errors::ParseError;
33pub use crate::map::Map;
34pub use crate::message::Message;
35pub use crate::player::Faction;
36pub use crate::player::Player;
37pub use crate::player::Team;
38pub use crate::replay::GameType;
39pub use crate::replay::Replay;