Merge pull request #7 from Bathtor/timer-ref-clone

Ensure that TimerRef is always Clone

Author: Bathtor

.github/workflows/ci.yml

@@ -62,7 +62,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly-2023-02-11
+          toolchain: nightly-2024-09-25
           override: true
           components: rustfmt, clippy
       - name: Checkout sources
@@ -91,7 +91,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly-2023-02-11
+          toolchain: nightly-2024-09-25
           override: true
           components: rustfmt, clippy
       - name: Checkout sources

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "hierarchical_hash_wheel_timer"
-version = "1.2.0"
+version = "1.3.0"
 authors = ["Lars Kroll <[email protected]>"]
-edition = "2018"
+edition = "2021"
 description = "A low-level timer implementantion using a hierarchical four-level hash wheel with overflow."
 documentation = "https://docs.rs/hierarchical_hash_wheel_timer"
 homepage = "https://github.com/Bathtor/rust-hash-wheel-timer"
@@ -26,23 +26,23 @@ fnv-hash = ["fnv"]
 fx-hash = ["rustc-hash"]
 
 [dependencies]
-uuid = { version = "1.3", features = ["v4"] , optional = true}
-fnv = { version = "1.0", optional = true}
-rustc-hash = {version = "1.1", optional = true}
-crossbeam-channel = {version = "0.5", optional = true}
+uuid = { version = "1.3", features = ["v4"], optional = true }
+fnv = { version = "1.0", optional = true }
+rustc-hash = { version = "2", optional = true }
+crossbeam-channel = { version = "0.5", optional = true }
 
 [badges]
 # Maintenance: `status` is required Available options are `actively-developed`,
 # `passively-maintained`, `as-is`, `none`, `experimental`, `looking-for-maintainer`
 # and `deprecated`.
 maintenance = { status = "passively-maintained" }
 
-travis-ci = { repository = "Bathtor/rust-hash-wheel-timer", branch = "master" }
+github-actions = { repository = "Bathtor/rust-hash-wheel-timer", workflow = "ci.yml" }
 
 [dev-dependencies]
-criterion = "0.3"
-rand = "0.7"
-rand_xoshiro = "0.4"
+criterion = "0.5"
+rand = "0.8"
+rand_xoshiro = "0.6"
 
 [[bench]]
 name = "wheel_benchmark"

rustfmt.toml

@@ -13,7 +13,7 @@ empty_item_single_line = true
 struct_lit_single_line = true
 fn_single_line = false
 where_single_line = false
-imports_granularity="Crate"
+imports_granularity = "Crate"
 imports_indent = "Block"
 imports_layout = "HorizontalVertical"
 reorder_imports = true
@@ -43,11 +43,11 @@ use_field_init_shorthand = false
 force_explicit_abi = true
 condense_wildcard_suffixes = false
 color = "Auto"
-required_version = "1.5.2"
+required_version = "1.8.0"
 unstable_features = false
 disable_all_formatting = false
 skip_children = false
-hide_parse_errors = false
+show_parse_errors = true
 error_on_line_overflow = false
 error_on_unformatted = false
 ignore = []

src/lib.rs

@@ -27,9 +27,9 @@
 //!
 //! - The [quad_wheel::QuadWheelWithOverflow](wheels::quad_wheel::QuadWheelWithOverflow) corresponds directly to the implementation described above.
 //! - The [cancellable::QuadWheelWithOverflow](wheels::cancellable::QuadWheelWithOverflow) additionally supports the cancellation of outstanding timers
-//! before they expire. In order to do so, however, it requires the generic timer entry type to provide a unique identifier field. It also uses
-//! [Rc](std::rc::Rc) internally to avoid double storing the actual entry, which makes it (potentialy) unsuitable for situations where the timer must
-//! be able to move threads (since Rc](std::rc::Rc) is not `Send`).
+//!   before they expire. In order to do so, however, it requires the generic timer entry type to provide a unique identifier field. It also uses
+//!   [Rc](std::rc::Rc) internally to avoid double storing the actual entry, which makes it (potentialy) unsuitable for situations where the timer must
+//!   be able to move threads (since Rc](std::rc::Rc) is not `Send`).
 //!
 //! # 3 – High Level APIs
 //! This crate also provides two high levels APIs that can either be used directly or can be seen as examples

src/thread_timer.rs

@@ -65,7 +65,6 @@ where
 /// This is used to schedule events on the timer from other threads.
 ///
 /// You can get an instance via [timer_ref](TimerWithThread::timer_ref).
-#[derive(Clone)]
 pub struct TimerRef<I, O, P>
 where
     I: Hash + Clone + Eq,
@@ -109,7 +108,18 @@ where
             .unwrap_or_else(|e| eprintln!("Could not send Cancel msg: {:?}", e));
     }
 }
-
+impl<I, O, P> Clone for TimerRef<I, O, P>
+where
+    I: Hash + Clone + Eq,
+    O: OneshotState<Id = I>,
+    P: PeriodicState<Id = I>,
+{
+    fn clone(&self) -> Self {
+        Self {
+            work_queue: self.work_queue.clone(),
+        }
+    }
+}
 /// A timer implementation that uses its own thread
 ///
 /// This struct acts as a main handle for the timer and its thread.
@@ -563,4 +573,14 @@ mod tests {
             assert!(*guard);
         }
     }
+
+    /// Check that the TimeRef is cloneable, even if its type parameters aren't.
+    #[test]
+    fn timer_ref_clone() {
+        let timer = TimerWithThread::for_uuid_closures();
+        let timer_ref: TimerRef<Uuid, OneShotClosureState<Uuid>, PeriodicClosureState<Uuid>> =
+            timer.timer_ref();
+        // No need to use it. Just checking that it compiles.
+        let _cloned_ref = timer_ref.clone();
+    }
 }

src/wheels/mod.rs

@@ -9,7 +9,6 @@ use std::{
     mem,
     rc::{Rc, Weak},
     time::Duration,
-    u32,
 };
 
 pub mod byte_wheel;

src/wheels/quad_wheel.rs

@@ -166,7 +166,7 @@ where
             self.secondary.current(),
             self.primary.current(),
         ];
-        u32::from_be(unsafe { mem::transmute(time_bytes) })
+        u32::from_be_bytes(time_bytes)
     }
 
     /// Insert a new timeout into the wheel to be returned after `delay` ticks