Move reset from unit to bool return type

Author: jmfrank63

governor/src/gcra.rs

@@ -438,9 +438,13 @@ mod test {
         assert!(lk.check_key(&key2).is_ok());
         assert!(lk.check_key(&key).is_err());
         assert!(lk.check_key(&key2).is_err());
-        assert_eq!(lk.reset_key(&key), ());
-        assert_eq!(lk.reset_key(&key2), ());
-        assert_eq!(lk.reset_key(&3), ());
+        assert!(lk.reset_key(&key));
+        assert!(lk.reset_key(&key2));
+        assert!(lk.reset_key(&3));
+        assert!(lk.reset_key(&key));
+        assert!(lk.reset_key(&key2));
+        assert!(lk.reset_key(&3));
+
         assert!(lk.check_key(&key).is_ok());
         assert!(lk.check_key(&key2).is_ok());
     }
@@ -484,7 +488,7 @@ mod test {
         for _ in 0..2 {
             assert!(lk.peek_key_n(&key2, nonzero!(1u32)).is_err());
         }
-        assert_eq!(lk.reset_key(&key), ());
+        assert!(lk.reset_key(&key));
         assert!(lk.check_key_n(&key, nonzero!(2u32)).is_ok());
         // TODO: impl Reference for FakeRelativeClock and test returned error
     }

governor/src/jitter.rs

@@ -203,7 +203,7 @@ mod test {
         let low = Duration::from_secs(0);
         let high = Duration::from_secs(20);
         let sampler = UniformJitter::new_inclusive(Nanos::from(low), Nanos::from(high));
-        assert!(format!("{:?}", sampler).len() > 0);
-        assert!(format!("{:?}", sampler.clone()).len() > 0);
+        assert!(!format!("{:?}", sampler).is_empty());
+        assert!(!format!("{:?}", sampler.clone()).is_empty());
     }
 }

governor/src/state.rs

@@ -52,7 +52,7 @@ pub trait StateStore {
     fn measure_and_peek<T, F, E>(&self, key: &Self::Key, f: F) -> Option<Result<T, E>>
     where
         F: Fn(Option<Nanos>) -> Result<(T, Nanos), E>;
-    fn reset(&self, key: &Self::Key);
+    fn reset(&self, key: &Self::Key) -> bool;
 }
 
 /// A rate limiter.

governor/src/state/in_memory.rs

@@ -93,8 +93,9 @@ impl StateStore for InMemoryState {
     {
         Some(self.measure_and_peek_one(f))
     }
-    fn reset(&self, _key: &Self::Key) {
+    fn reset(&self, _key: &Self::Key) -> bool {
         self.0.store(0, Ordering::Release);
+        true
     }
 }
 

governor/src/state/keyed.rs

@@ -104,8 +104,8 @@ where
             .peek_test::<K, C::Instant, S, MW>(self.start, key, &self.state, self.clock.now())
     }
 
-    pub fn reset_key(&self, key: &K) {
-        self.state.reset(key);
+    pub fn reset_key(&self, key: &K) -> bool {
+        self.state.reset(key)
     }
 
     /// Allow *only all* `n` cells through the rate limiter for the given key.
@@ -289,7 +289,7 @@ mod test {
                 Some(f(None).map(|(res, _)| res))
             }
 
-            fn reset(&self, _key: &Self::Key) {}
+            fn reset(&self, _key: &Self::Key) -> bool { true }
         }
 
         impl<K: Hash + Eq + Clone> ShrinkableKeyedStateStore<K> for NaiveKeyedStateStore<K> {
@@ -318,7 +318,7 @@ mod test {
         assert_eq!(lim.len(), 0);
         assert!(lim.peek_key(&1u32).is_ok());
         assert!(lim.check_key(&1u32).is_ok());
-        assert_eq!(lim.reset_key(&1u32), ());
+        assert!(lim.reset_key(&1u32));
         assert!(lim.is_empty());
         assert_eq!(lim.len(), 0);
         lim.retain_recent();

governor/src/state/keyed/dashmap.rs

@@ -41,8 +41,8 @@ impl<K: Hash + Eq + Clone> StateStore for DashMapStateStore<K> {
         Some((*entry).measure_and_peek_one(f))
     }
 
-    fn reset(&self, key: &Self::Key) {
-        self.remove(key);
+    fn reset(&self, key: &Self::Key) -> bool{
+        self.remove(key).is_some()
     }
 }
 

governor/src/state/keyed/hashmap.rs

@@ -45,9 +45,10 @@ impl<K: Hash + Eq + Clone> StateStore for HashMapStateStore<K> {
         (*self.lock()).get(key).map(|v| v.measure_and_peek_one(f))
     }
 
-    fn reset(&self, key: &Self::Key) {
+    fn reset(&self, key: &Self::Key) -> bool{
         let mut map = self.lock();
         map.remove(key);
+        true
     }
 }