DOC: Add a note about the changed behavior in is_abandoned()

mgeier · May 2, 2024 · bdf60a1 · bdf60a1
1 parent 0976460
commit bdf60a1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -389,6 +389,10 @@ impl<T> Producer<T> {
 
  /// Returns `true` if the corresponding [`Consumer`] has been destroyed.
  ///
+ /// Note that since Rust version 1.74.0, this is not synchronizing with the consumer thread
+ /// anymore, see <https://github.com/mgeier/rtrb/issues/114>.
+ /// In a future version of `rtrb`, the synchronizing behavior might be restored.
+ ///
  /// # Examples
  ///
  /// ```
@@ -629,6 +633,10 @@ impl<T> Consumer<T> {
 
  /// Returns `true` if the corresponding [`Producer`] has been destroyed.
  ///
+ /// Note that since Rust version 1.74.0, this is not synchronizing with the producer thread
+ /// anymore, see <https://github.com/mgeier/rtrb/issues/114>.
+ /// In a future version of `rtrb`, the synchronizing behavior might be restored.
+ ///
  /// # Examples
  ///
  /// ```