fix: imports in docs

Author: thatdevsherry

src/control_client/mod.rs

@@ -17,13 +17,18 @@ use tokio::net::TcpStream;
 use tokio::sync::oneshot;
 use tracing::*;
 
-/// Control-Client is responsible for initiating and handling TWAMP-Control with a Server.
+/// Control-Client is responsible for initiating and handling TWAMP-Control with a
+/// [Server](crate::server::Server).
 ///
-/// Responsibilites of Control-Client on TWAMP-Control are:
+/// Responsibilites of Control-Client on TWAMP-Control, in sequence, are:
 /// -   [Read Server Greeting](Self::read_server_greeting)
 /// -   [Send Set-Up-Response](Self::send_set_up_response)
 /// -   [Read Server-Start](Self::read_server_start)
 /// -   [Send Request-TW-Session](Self::send_request_tw_session)
+/// -   [Read Accept-Session](Self::read_accept_session)
+/// -   [Send Start-Sessions](Self::send_start_sessions)
+/// -   [Read Start-Ack](Self::read_start_ack)
+/// -   [Send Stop-Sessions](Self::send_stop_sessions)
 #[derive(Debug)]
 pub struct ControlClient {
     /// TCP stream on which TWAMP-Control is being used.
@@ -34,7 +39,7 @@ impl ControlClient {
     pub fn new() -> Self {
         Self { stream: None }
     }
-    /// Initiates TCP connection and starts the [TWAMP-Control](twamp_control) protocol with
+    /// Initiates TCP connection and starts the [TWAMP-Control](crate::twamp_control) protocol with
     /// Server, handling communication until the test ends or connection is killed/stopped.
     pub async fn do_twamp_control(
         &mut self,
@@ -75,13 +80,12 @@ impl ControlClient {
         Ok(())
     }
 
-    /// Reads from TWAMP-Control stream assuming the bytes to be received will be of a
-    /// `ServerGreeting`. Converts those bytes into a `ServerGreeting` struct and returns it.
+    /// Reads [`ServerGreeting`] from TWAMP-Control stream.
     pub async fn read_server_greeting(&mut self) -> Result<ServerGreeting> {
         let mut buf = [0; size_of::<ServerGreeting>()];
         info!("Reading ServerGreeting");
         self.stream.as_mut().unwrap().read_exact(&mut buf).await?;
-        let (_rest, server_greeting) = ServerGreeting::from_bytes((&buf, 0)).unwrap();
+        let (_rest, server_greeting) = ServerGreeting::from_bytes((&buf, 0)).expect("should have received valid ServerGreeting");
         debug!("Server greeting: {:?}", server_greeting);
         info!("Done reading ServerGreeting");
         Ok(server_greeting)

src/server/mod.rs

@@ -16,7 +16,7 @@ use tokio::net::TcpStream;
 use tokio::sync::oneshot;
 use tracing::*;
 
-/// Server is responsible for handling incoming [TWAMP-Control](twamp_control) connection from a
+/// Server is responsible for handling incoming [TWAMP-Control](crate::twamp_control) connection from a
 /// Control-Client.
 #[derive(Debug)]
 pub struct Server {

src/twamp_control/accept_session.rs

@@ -1,7 +1,7 @@
 use super::Accept;
 use deku::prelude::*;
 
-/// Response for a Request-TW-Session command.
+/// Response for a [Request-TW-Session](super::RequestTwSession) command.
 #[derive(Clone, Debug, PartialEq, DekuRead, DekuWrite)]
 #[deku(endian = "big")]
 pub struct AcceptSession {

src/twamp_control/server_greeting.rs

@@ -4,7 +4,7 @@ use super::SecurityMode;
 use deku::prelude::*;
 use rand::random;
 
-/// Server Greeting sent by `Server` to `Control-Client` after `Control-Client` opens up a TCP
+/// Server Greeting sent by [`Server`](crate::server::Server) to [`Control-Client`](crate::control_client) after [`Control-Client`](crate::control_client) opens up a TCP
 /// connection.
 ///
 /// See details in [RFC 4656](https://datatracker.ietf.org/doc/html/rfc4656#section-3.1).

src/twamp_control/server_start.rs

@@ -4,7 +4,7 @@ use deku::prelude::*;
 use rand::random;
 use std::time::Duration;
 
-/// Sent by Server to Control-Client after receiving a [Set-Up-Response](crate::set_up_response::SetUpResponse) command.
+/// Sent by Server to Control-Client after receiving a [Set-Up-Response](crate::twamp_control::SetUpResponse) command.
 #[derive(Clone, Debug, PartialEq, DekuRead, DekuWrite)]
 #[deku(endian = "big")]
 pub struct ServerStart {
@@ -16,7 +16,7 @@ pub struct ServerStart {
     accept: Accept,
 
     /// Generated randomly. Unused in
-    /// [unauthenticated mode](crate::security_mode::Mode::Unauthenticated).
+    /// [unauthenticated mode](crate::twamp_control::SecurityMode::Unauthenticated).
     server_iv: [u8; 16],
 
     /// The time when the Server binary was executed.

src/twamp_control/set_up_response.rs

@@ -3,13 +3,13 @@ use anyhow::Result;
 use deku::prelude::*;
 
 /// Sent by Control-Client to Server through TWAMP-Control after receiving
-/// [Server Greeting](crate::server_greeting::ServerGreeting).
+/// [Server Greeting](crate::twamp_control::ServerGreeting).
 #[derive(Clone, Debug, PartialEq, DekuRead, DekuWrite)]
 #[deku(endian = "big")]
 pub struct SetUpResponse {
     /// The [security mode](crate::security_mode::Mode) that `Control-Client` wishes to use.
     /// It **should** be a mode that the Server supports, which it had sent in
-    /// [Server Greeting](crate::server_greeting::ServerGreeting).
+    /// [Server Greeting](crate::twamp_control::ServerGreeting).
     mode: SecurityMode,
 
     /// UTF-8 string up to 80 bytes, padded with zeros if shorter. Tells `Server` which shared
@@ -19,14 +19,14 @@ pub struct SetUpResponse {
     /// acts as MBZ (Must Be Zero).
     key_id: [u8; 80],
 
-    /// Concatenation of [challenge](crate::server_greeting::ServerGreeting::challenge), AES
+    /// Concatenation of [challenge](crate::twamp_control::ServerGreeting::challenge), AES
     /// Session-Key and HMAC-SHA1 Session-Key.
     ///
-    /// Unused in [unauthenticated mode](crate::security_mode::Mode::Unauthenticated) and
+    /// Unused in [unauthenticated mode](crate::twamp_control::SecurityMode::Unauthenticated) and
     /// acts as MBZ (Must Be Zero).
     token: [u8; 64],
 
-    /// Unused in [unauthenticated mode](crate::security_mode::Mode::Unauthenticated) and
+    /// Unused in [unauthenticated mode](crate::twamp_control::SecurityMode::Unauthenticated) and
     /// acts as MBZ (Must Be Zero).
     client_iv: [u8; 16],
 }