fix: typo

Author: Lethe10137

rattan-core/src/cells/bandwidth/mod.rs

@@ -208,7 +208,7 @@ where
         // Here, either:
         //    1) No more packets can be retrived from egress, or
         //    2) A packet, that should enter the queue after `self.next_available` is seen.
-        // Thus the `dequeue_at()` see a correct queue, containing any packet that should
+        // Thus the `dequeue_at()` sees a correct queue, containing any packet that should
         // enter the AQM at `self.next_available`.
         let mut packet = self.packet_queue.dequeue_at(self.next_available);
 
@@ -503,8 +503,8 @@ where
         if let Some((bandwidth, duration)) = self.trace.next_bw() {
             self.change_bandwidth(bandwidth, change_time);
             self.next_change = change_time + duration;
-            // #[cfg(test)]
-            eprintln!(
+            #[cfg(test)]
+            trace!(
                 "Bandwidth changed to {:?}, next change after {:?}. now {:?}",
                 bandwidth,
                 self.next_change - Instant::now(),
@@ -602,7 +602,7 @@ where
         // Here, either:
         //    1) No more packets can be retrived from egress, or
         //    2) A packet, that should enter the queue after `self.next_available` is seen.
-        // Thus the `dequeue_at()` see a correct queue, containing any packet that should
+        // Thus the `dequeue_at()` sees a correct queue, containing any packet that should
         // enter the AQM at `self.next_available`.
         let mut packet = self.packet_queue.dequeue_at(self.next_available);
 
@@ -655,7 +655,6 @@ where
     fn reset(&mut self) {
         self.next_available = *TRACE_START_INSTANT.get_or_init(Instant::now);
         self.next_change = *TRACE_START_INSTANT.get_or_init(Instant::now);
-        eprintln!("Reset to {:?}", self.next_change);
     }
 
     fn change_state(&self, state: CellState) {

rattan-core/src/cells/bandwidth/queue.rs

@@ -68,7 +68,9 @@ where
             .is_none_or(|t| t <= next_available)
     }
 
-    /// Return the packet immediately, if the inner queue is zero-buffered.
+    /// Enqueue a packet into the AQM.
+    ///
+    /// If the inner queue is zero-buffered, the packet is returned immediately.
     pub fn enqueue(&mut self, packet: P) -> Option<P> {
         self.latest_enqueue_timestamp = packet.get_timestamp().into();
         if self.queue.is_zero_buffer() {
@@ -79,9 +81,13 @@ where
         }
     }
 
+    /// Dequeue a packet from the AQM based on the timestamp.
+    /// The function tries to maintain the queue status at the given timestamp before dequeing a packet,
+    /// by enqueuing any packets that should have been enqueued by that timestamp.
+    ///
     /// The caller ensures that:
-    ///   1) This function is not called before the `timestamp` here.
-    ///   2) The timestamp should be non-decending.
+    ///   1) This function is not called before the wall-clock time of `timestamp`.
+    ///   2) The timestamp should be non-descending.
     pub fn dequeue_at(&mut self, timestamp: Instant) -> Option<P> {
         while let Some(head) = self.inbound_buffer.front() {
             if head.get_timestamp() <= timestamp {