source2-demo 0.4.2

Dota 2 / Deadlock / CS2 replay parser written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

#![doc = include_str!("../README.md")]
#![doc(html_root_url = "https://docs.rs/source2-demo/0.3.2")]
#![warn(missing_docs)]
#![allow(clippy::too_many_arguments)]


mod display;
mod entity;
pub mod error;
mod event;
mod macros;
mod parser;
mod reader;
mod string_table;

/// Protocol buffer definitions for Source 2 games.
///
/// This module re-exports all protobuf message types used by the parser.
/// The available messages depend on which game feature is enabled.
///
/// # Examples
///
/// ```no_run
/// use source2_demo::proto::*;
///
/// // Decode a protobuf message
/// let msg = CDemoFileInfo::decode(bytes)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub mod proto {
    pub use source2_demo_protobufs::prost::Message;
    pub use source2_demo_protobufs::*;
}

/// Prelude module for convenient imports.
///
/// Import this module to get access to all commonly used types and traits:
///
/// ```
/// use source2_demo::prelude::*;
/// ```
///
/// This includes:
/// - Core types: [`Parser`], [`Context`], [`Entity`], [`Observer`]
/// - Traits and macros: [`observer`], [`on_message`], [`property!`]
/// - Protobuf enums: Message type enumerations for each game
pub mod prelude {
    pub use crate::entity::{Entity, EntityEvents};
    pub use crate::event::{EventValue, GameEvent, GameEventList};
    pub use crate::parser::*;
    pub use crate::string_table::*;
    pub use crate::{property, try_property};

    pub use source2_demo_macros::*;

    pub use source2_demo_protobufs::prost::Message;
    pub use source2_demo_protobufs::EBaseGameEvents;
    pub use source2_demo_protobufs::EBaseUserMessages;
    pub use source2_demo_protobufs::EDemoCommands;
    pub use source2_demo_protobufs::NetMessages;
    pub use source2_demo_protobufs::SvcMessages;

    #[cfg(feature = "dota")]
    pub use crate::event::CombatLogEntry;
    #[cfg(feature = "dota")]
    pub use crate::proto::EDotaUserMessages;

    #[cfg(feature = "deadlock")]
    pub use crate::proto::CitadelUserMessageIds;
    #[cfg(feature = "deadlock")]
    pub use crate::proto::ECitadelGameEvents;

    #[cfg(feature = "cs2")]
    pub use crate::proto::ECstrike15UserMessages;
    #[cfg(feature = "cs2")]
    pub use crate::proto::ECsgoGameEvents;
}

// Re-export commonly used types at the crate root
pub use crate::entity::field::FieldValue;
pub use crate::entity::*;
pub use crate::event::*;
pub use crate::parser::*;
pub use crate::string_table::*;
pub use source2_demo_macros::*;

/// Fast hash map using FxHash algorithm.
///
/// This type alias is used throughout the crate for better performance
/// compared to the standard library's `HashMap`.
pub type HashMap<K, V> =
hashbrown::HashMap<K, V, rustc_hash::FxBuildHasher>;

/// Fast hash set using FxHash algorithm.
///
/// This type alias is used throughout the crate for better performance
/// compared to the standard library's `HashSet`.
pub type HashSet<T> =
hashbrown::HashSet<T, rustc_hash::FxBuildHasher>;


#[cfg(feature = "dota")]
pub use crate::event::CombatLogEntry;

#[cfg(feature = "mimalloc")]
use mimalloc::MiMalloc;
#[cfg(feature = "mimalloc")]
#[global_allocator]
static GLOBAL: MiMalloc = MiMalloc;