Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mark_unchanged method to watch::Receiver #6252

Merged
merged 4 commits into from
Dec 30, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tokio/src/sync/watch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,26 @@ impl<T> Receiver<T> {
self.version.decrement();
}

/// Marks the state as unchanged.
///
/// The current value will be considered seen by the receiver.
///
/// After calling this method in a single-threaded context, a subsequent call to
/// [`has_changed()`](Self::has_changed) will return `false`, and a subsequent call
/// to [`changed()`](Self::changed) will yield.
///
/// After calling this method in a multi-threaded context, subsequent
/// behaviour will vary depending on if a value is sent concurrently.
/// For example, a new value could be sent before this method returns
/// which would cause a call to [`changed`](Self::changed) to return immediately
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, I think this is more confusing than it is useful. It's not clear what "single-threaded context" and "multi-threaded context" means. Does code running on a multi-threaded runtime necessarily imply that you are in a "multi-threaded context" according to this paragraph? No, but I anticipate being asked that question in the future. I would rather just take it out entirely.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I'm cool with removing it

///
/// This is useful if you are not interested in the current value
/// visible in the receiver.
pub fn mark_unchanged(&mut self) {
let current_version = self.shared.state.load().version();
self.version = current_version;
}

/// Waits for a change notification, then marks the newest value as seen.
///
/// If the newest value in the channel has not yet been marked seen when
Expand Down
33 changes: 33 additions & 0 deletions tokio/tests/sync_watch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,39 @@ fn rx_mark_changed() {
assert_eq!(*rx.borrow(), "two");
}

#[test]
fn rx_mark_unchanged() {
let (tx, mut rx) = watch::channel("one");

let mut rx2 = rx.clone();

{
assert!(!rx.has_changed().unwrap());

rx.mark_changed();
assert!(rx.has_changed().unwrap());

rx.mark_unchanged();
assert!(!rx.has_changed().unwrap());

let mut t = spawn(rx.changed());
assert_pending!(t.poll());
}

{
assert!(!rx2.has_changed().unwrap());

tx.send("two").unwrap();
assert!(rx2.has_changed().unwrap());

rx2.mark_unchanged();
assert!(!rx2.has_changed().unwrap());
assert_eq!(*rx2.borrow_and_update(), "two");
}

assert_eq!(*rx.borrow(), "two");
}

#[test]
fn multi_rx() {
let (tx, mut rx1) = watch::channel("one");
Expand Down
Loading