From 298c260c5f4df57c32bbb79e3aa04ddd5b7c9e7b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Sun, 23 Aug 2020 16:57:34 +0200
Subject: [PATCH] crypto: Document the outgoing request types.

---
 matrix_sdk_crypto/src/requests.rs | 29 ++++++++++++++++++-----------
 1 file changed, 18 insertions(+), 11 deletions(-)

diff --git a/matrix_sdk_crypto/src/requests.rs b/matrix_sdk_crypto/src/requests.rs
index 0b102076..a63d86a0 100644
--- a/matrix_sdk_crypto/src/requests.rs
+++ b/matrix_sdk_crypto/src/requests.rs
@@ -28,14 +28,17 @@ use matrix_sdk_common::{
     uuid::Uuid,
 };
 
-/// TODO
+/// Enum over the different outgoing requests we can have.
 #[derive(Debug)]
 pub enum OutgoingRequests {
-    /// TODO
+    /// The keys upload request, uploading device and one-time keys.
     KeysUpload(KeysUploadRequest),
-    /// TODO
+    /// The keys query request, fetching the device and cross singing keys of
+    /// other users.
     KeysQuery(KeysQueryRequest),
-    /// TODO
+    /// The to-device requests, this request is used for a couple of different
+    /// things, the main use is key requests/forwards and interactive device
+    /// verification.
     ToDeviceRequest(ToDeviceRequest),
 }
 
@@ -57,16 +60,19 @@ impl From<ToDeviceRequest> for OutgoingRequests {
     }
 }
 
-/// TODO
+/// Enum over all the incoming responses we need to receive.
 #[derive(Debug)]
 pub enum IncomingResponse<'a> {
-    /// TODO
+    /// The keys upload response, notifying us about the amount of uploaded
+    /// one-time keys.
     KeysUpload(&'a KeysUploadResponse),
-    /// TODO
+    /// The keys query response, giving us the device and cross singing keys of
+    /// other users.
     KeysQuery(&'a KeysQueryResponse),
-    /// TODO
+    /// The to-device response, an empty response.
     ToDevice(&'a ToDeviceResponse),
-    ///
+    /// The key claiming requests, giving us new one-time keys of other users so
+    /// new Olm sessions can be created.
     KeysClaim(&'a KeysClaimResponse),
 }
 
@@ -94,13 +100,14 @@ impl<'a> From<&'a KeysClaimResponse> for IncomingResponse<'a> {
     }
 }
 
-/// TODO
+/// Outgoing request type, holds the unique ID of the request and the actual
+/// request.
 #[derive(Debug, Clone)]
 pub struct OutgoingRequest {
     /// The unique id of a request, needs to be passed when receiving a
     /// response.
     pub(crate) request_id: Uuid,
-    /// TODO
+    /// The underlying outgoing request.
     pub(crate) request: Arc<OutgoingRequests>,
 }