Add Interval::set_period, Interval::tick_no_spin

util/CHANGELOG.md

@@ -1,2 +1,5 @@
+# Unreleased (v0.1.1)
+* Add `Interval::set_period`, `Interval::tick_no_spin`.
+
 # v0.1.0
 * Add `Interval`, `RateReporter`.

util/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "spin_sleep_util"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Alex Butler <[email protected]>"]
 description = "Utils using spin_sleep"
@@ -10,4 +10,4 @@ license = "Apache-2.0"
 readme = "README.md"
 
 [dependencies]
-spin_sleep = { path = "..", version = "1" }
+spin_sleep = { path = "..", version = "1.2" }

util/src/interval.rs

@@ -44,13 +44,29 @@ pub struct Interval {
 }
 
 impl Interval {
-    /// Use [`SpinSleeper`] to sleep until the next scheduled tick.
+    /// Use [`SpinSleeper::sleep`] to sleep until the next scheduled tick.
     ///
     /// If the tick is in the past will return without sleeping
     /// computing the next tick based on the configured [`MissedTickBehavior`].
     ///
     /// Returns the tick time.
     pub fn tick(&mut self) -> Instant {
+        self.tick_with_spin(true)
+    }
+
+    /// Use [`spin_sleep::native_sleep`] to sleep until the next scheduled tick.
+    /// **Does not spin.**
+    ///
+    /// If the tick is in the past will return without sleeping
+    /// computing the next tick based on the configured [`MissedTickBehavior`].
+    ///
+    /// Returns the tick time.
+    pub fn tick_no_spin(&mut self) -> Instant {
+        self.tick_with_spin(false)
+    }
+
+    #[inline]
+    fn tick_with_spin(&mut self, spin: bool) -> Instant {
         let tick = self.next_tick;
         let now = Instant::now();
 
@@ -60,13 +76,16 @@ impl Interval {
             return tick;
         }
 
-        self.sleeper.sleep(tick - now);
+        match spin {
+            true => self.sleeper.sleep(tick - now),
+            false => spin_sleep::native_sleep(tick - now),
+        };
 
         self.next_tick = tick + self.period;
         tick
     }
 
-    /// Resets the interval to complete one period after the current time.
+    /// Resets the scheduled next tick to one period after the current time.
     pub fn reset(&mut self) {
         self.next_tick = Instant::now() + self.period;
     }
@@ -99,6 +118,25 @@ impl Interval {
         self.period
     }
 
+    /// Sets a new period.
+    ///
+    /// Does not affect the existing scheduled next tick.
+    ///
+    /// # Example
+    /// ```
+    /// use spin_sleep_util::interval;
+    /// # use std::time::Duration;
+    ///
+    /// let mut i = interval(Duration::from_millis(20));
+    /// i.set_period(Duration::from_secs(1));
+    /// assert_eq!(i.period(), Duration::from_secs(1));
+    /// ```
+    #[track_caller]
+    pub fn set_period(&mut self, period: Duration) {
+        assert!(period > Duration::ZERO, "`period` must be non-zero.");
+        self.period = period;
+    }
+
     /// Sets the [`MissedTickBehavior`] strategy that should be used.
     ///
     /// # Example