Add comments to room module.

client/src/room/event.rs

@@ -1,3 +1,5 @@
+//! This module defines events affecting the room module and their handling.
+
 use solstice_proto::server::{
   RoomJoinResponse, RoomListResponse, RoomMessageResponse,
 };
@@ -11,6 +13,7 @@ use crate::handlers::{
 };
 use crate::message_handler::MessageHandler;
 
+/// An event affecting the chat room module.
 #[derive(Debug, PartialEq, Eq)]
 pub enum RoomEvent {
   JoinRequest(String),
@@ -21,7 +24,11 @@ pub enum RoomEvent {
   MessageResponse(RoomMessageResponse),
 }
 
+/// An interface for room event handlers.
+///
+/// Allows mocking of handlers in tests.
 pub trait HandleRoomEvent {
+  /// Handles the given `event` against the given global `context`.
   fn handle(
     &mut self,
     context: &mut Context,
@@ -29,6 +36,7 @@ pub trait HandleRoomEvent {
   ) -> anyhow::Result<()>;
 }
 
+/// The real, default implementation of `HandleRoomEvent`.
 #[derive(Default)]
 pub struct RoomEventHandler;
 

client/src/room/map.rs

@@ -1,3 +1,6 @@
+//! This module defines abstractions for handling the global set of rooms and
+//! their state.
+
 use std::collections::HashMap;
 use std::mem;
 

client/src/room/state.rs

@@ -1,3 +1,6 @@
+//! This module defines the data structures used for room state storage and
+//! serialization.
+
 use std::collections::HashSet;
 use std::time::SystemTime;