feat(model): support transition to endless model

- add `Forever` trait to do the transition work

Resolves: #9

Author: BobAnkh

.github/workflows/cargo-lint.yml

@@ -82,7 +82,7 @@ jobs:
         uses: BobAnkh/clippy-check@master
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-features --workspace
+          args: --all-targets --all-features --workspace --no-deps
 
   cargo-fmt:
     runs-on: ubuntu-latest

src/lib.rs

@@ -79,7 +79,7 @@
 //! }
 //! ```
 //!
-//! This is almost the same as how this library implements the [`StaticBw`] model.
+//! This is almost the same as how this library implements the [`model::StaticBw`] model.
 //!
 //! ## Features
 //!
@@ -179,6 +179,8 @@ pub trait LossTrace: Send {
 
 #[cfg(test)]
 mod test {
+    use self::model::bw::Forever;
+
     use super::*;
     use crate::model::{
         BwTraceConfig, NormalizedBwConfig, RepeatedBwPatternConfig, SawtoothBwConfig,
@@ -337,4 +339,48 @@ mod test {
             Some((Bandwidth::from_mbps(12), Duration::from_secs(1)))
         );
     }
+
+    #[test]
+    fn test_forever() {
+        let mut normal_bw = NormalizedBwConfig::new()
+            .mean(Bandwidth::from_mbps(12))
+            .std_dev(Bandwidth::from_mbps(1))
+            .duration(Duration::from_millis(200))
+            .step(Duration::from_millis(100))
+            .seed(42)
+            .build();
+        assert_eq!(
+            normal_bw.next_bw(),
+            Some((Bandwidth::from_bps(12069427), Duration::from_millis(100)))
+        );
+        assert_eq!(
+            normal_bw.next_bw(),
+            Some((Bandwidth::from_bps(12132938), Duration::from_millis(100)))
+        );
+        assert_eq!(normal_bw.next_bw(), None);
+        let normal_bw_config = NormalizedBwConfig::new()
+            .mean(Bandwidth::from_mbps(12))
+            .std_dev(Bandwidth::from_mbps(1))
+            .duration(Duration::from_millis(200))
+            .step(Duration::from_millis(100))
+            .seed(42);
+        let normal_bw_repeated = normal_bw_config.forever();
+        let mut model = Box::new(normal_bw_repeated).into_model();
+        assert_eq!(
+            model.next_bw(),
+            Some((Bandwidth::from_bps(12069427), Duration::from_millis(100)))
+        );
+        assert_eq!(
+            model.next_bw(),
+            Some((Bandwidth::from_bps(12132938), Duration::from_millis(100)))
+        );
+        assert_eq!(
+            model.next_bw(),
+            Some((Bandwidth::from_bps(12069427), Duration::from_millis(100)))
+        );
+        assert_eq!(
+            model.next_bw(),
+            Some((Bandwidth::from_bps(12132938), Duration::from_millis(100)))
+        );
+    }
 }

src/model/bw.rs

@@ -791,3 +791,32 @@ impl_bw_trace_config!(StaticBwConfig);
 impl_bw_trace_config!(NormalizedBwConfig);
 impl_bw_trace_config!(SawtoothBwConfig);
 impl_bw_trace_config!(RepeatedBwPatternConfig);
+
+/// Turn a [`BwTraceConfig`] into a forever repeated [`RepeatedBwPatternConfig`].
+pub trait Forever: BwTraceConfig {
+    fn forever(self) -> RepeatedBwPatternConfig;
+}
+
+/// Implement the [`Forever`] trait for the bandwidth trace model config (any struct implements [`BwTraceConfig`]).
+#[macro_export]
+macro_rules! impl_forever {
+    ($name:ident) => {
+        impl Forever for $name {
+            fn forever(self) -> RepeatedBwPatternConfig {
+                RepeatedBwPatternConfig::new()
+                    .pattern(vec![Box::new(self)])
+                    .count(0)
+            }
+        }
+    };
+}
+
+impl_forever!(StaticBwConfig);
+impl_forever!(NormalizedBwConfig);
+impl_forever!(SawtoothBwConfig);
+
+impl Forever for RepeatedBwPatternConfig {
+    fn forever(self) -> RepeatedBwPatternConfig {
+        self.count(0)
+    }
+}

src/model/mod.rs

@@ -15,7 +15,8 @@ pub mod bw;
 
 #[cfg(feature = "bw-model")]
 pub use bw::{
-    BwTraceConfig, NormalizedBwConfig, RepeatedBwPatternConfig, SawtoothBwConfig, StaticBwConfig,
+    BwTraceConfig, Forever, NormalizedBwConfig, RepeatedBwPatternConfig, SawtoothBwConfig,
+    StaticBwConfig,
 };
 #[cfg(feature = "bw-model")]
 pub use bw::{NormalizedBw, RepeatedBwPattern, SawtoothBw, StaticBw};