aboutsummaryrefslogtreecommitdiff
path: root/games/rstnode/rst-core/src/_match.rs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--games/rstnode/rst-core/src/_match.rs (renamed from games/rstnode/src/_match.rs)5
1 files changed, 5 insertions, 0 deletions
diff --git a/games/rstnode/src/_match.rs b/games/rstnode/rst-core/src/_match.rs
index 6ae69c54e935..ce75af5af393 100644
--- a/games/rstnode/src/_match.rs
+++ b/games/rstnode/rst-core/src/_match.rs
@@ -10,6 +10,11 @@ use serde::{Deserialize, Serialize};
use std::collections::VecDeque;
/// Describes a match for the server
+///
+/// This type implements the partial [GameIf](crate::GameIf) API to
+/// allow client to queue commands from players. The server
+/// implementation runs a simulation for each match that is running on
+/// it.
pub struct Match {
/// The match id
pub id: MatchId,