aquatic_ws_protocol: add documentation (as comments)

aquatic_ws_protocol/src/lib.rs

@@ -1,3 +1,15 @@
+//! WebTorrent protocol implementation
+//!
+//! Typical announce workflow:
+//! - Peer A sends announce request with info hash and offers
+//! - Tracker sends on offers to other peers announcing with that info hash and
+//!   sends back announce response to peer A
+//! - Tracker receives answers to those offers from other peers and send them
+//!   on to peer A
+//!
+//! Typical scrape workflow
+//! - Peer sends scrape request and receives scrape response
+
 pub mod common;
 pub mod request;
 pub mod response;

aquatic_ws_protocol/src/request/mod.rs

@@ -7,6 +7,7 @@ pub mod scrape;
 pub use announce::*;
 pub use scrape::*;
 
+/// Message received by tracker
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum InMessage {

aquatic_ws_protocol/src/response/mod.rs

@@ -12,14 +12,15 @@ pub use error::*;
 pub use offer::*;
 pub use scrape::*;
 
+/// Message sent by tracker
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum OutMessage {
-    Offer(offer::MiddlemanOfferToPeer),
+    Offer(MiddlemanOfferToPeer),
-    Answer(answer::MiddlemanAnswerToPeer),
+    Answer(MiddlemanAnswerToPeer),
-    AnnounceResponse(announce::AnnounceResponse),
+    AnnounceResponse(AnnounceResponse),
-    ScrapeResponse(scrape::ScrapeResponse),
+    ScrapeResponse(ScrapeResponse),
-    ErrorResponse(error::ErrorResponse),
+    ErrorResponse(ErrorResponse),
 }
 
 impl OutMessage {