docs(project): added docstrings to all code files

caesar-core/src/receiver/mod.rs

@@ -10,6 +10,23 @@ use tokio_tungstenite::{
 };
 use tracing::{debug, error};
 
+/// Start the receiver process.
+///
+/// This function initiates the receiver process by performing the following steps:
+/// 1. Replaces the protocol of the given `relay` URL.
+/// 2. Downloads the room information from the server.
+/// 3. Connects to the local or relay server based on the platform.
+/// 4. Downloads the file from the server.
+///
+/// # Arguments
+///
+/// * `filepath` - The path to the file to be received.
+/// * `relay` - The URL of the relay server.
+/// * `name` - The name of the receiver.
+///
+/// # Returns
+///
+/// Returns a `Result` indicating the success or failure of the receiver process.
 pub async fn start_receiver(filepath: String, relay: &str, name: &str) -> Result<()> {
     let http_url = replace_protocol(relay);
     let res = http_client::download_info(http_url.as_str(), name)
@@ -44,33 +61,55 @@ pub async fn start_receiver(filepath: String, relay: &str, name: &str) -> Result
     Ok(())
 }
 
+/// Asynchronously starts a WebSocket communication with a relay server.
+///
+/// # Arguments
+///
+/// * `filepath` - The path of the file to transfer.
+/// * `relay` - The URL of the relay server.
+/// * `name` - The name of the receiver.
+///
+/// # Returns
+///
+/// Returns a `Result` indicating the success or failure of the WebSocket communication.
 pub async fn start_ws_com(filepath: String, relay: &str, name: &str) -> Result<()> {
+    // Construct the WebSocket URL by appending "/ws" to the relay URL.
     let url = String::from(relay) + "/ws";
+
+    // Create a WebSocket request using the constructed URL.
     let mut request = url
         .into_client_request()
         .map_err(|e| anyhow!("Failed to create request: {}", e))?;
 
+    // Set the "Origin" header of the request to the relay URL.
     request
         .headers_mut()
         .insert("Origin", HeaderValue::from_str(relay).unwrap());
 
+    // Print a message indicating the attempt to connect.
     println!("Attempting to connect...");
 
+    // Attempt to establish a WebSocket connection with the relay server.
+    // If the connection fails or times out, return an error.
     let _ = match tokio::time::timeout(std::time::Duration::from_secs(5), connect_async(request))
         .await
     {
         Ok(Ok((socket, _))) => {
+            // Start the receiver process with the established WebSocket connection.
             receiver::start(filepath, socket, name).await;
             Ok(())
         }
         Ok(Err(e)) => {
+            // Log the failure to connect.
             error!("Error: Failed to connect: {e:?}");
             Err(Box::new(e))
         }
         Err(e) => {
+            // Log the timeout.
             error!("Error: Timeout reached for local connection attempt");
             Err(Box::new(e))
         }?,
     };
     Ok(())
 }
+