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.

Sign up for GitHub

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

Jump to bottom

sync::watch: Change wording from "unseen" to "changed" #6014

Merged
merged 4 commits into from Sep 19, 2023
Merged

sync::watch: Change wording from "unseen" to "changed" #6014

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3cce78d
sync::watch: Change wording from "unseen" to "unchanged"
uklotzde Sep 18, 2023
46717bd
Fix wording: mark_unchanged() -> mark_changed()
uklotzde Sep 18, 2023
e14644c
Update tokio/src/sync/watch.rs
uklotzde Sep 18, 2023
bc3b49d
Update docs
uklotzde Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions tokio/src/sync/watch.rs
View file
Open in desktop
Expand Up @@ -380,7 +380,7 @@ mod state {
impl Version {
/// Get the initial version when creating the channel.
pub(super) fn initial() -> Self {
// The initial version is 1 so that `mark_unseen` can decrement by one.
// The initial version is 1 so that `mark_changed` can decrement by one.
// (The value is 2 due to the closed bit.)
Version(2)
}
Expand Down Expand Up @@ -645,7 +645,7 @@ impl<T> Receiver<T> {
}

/// Marks the state as unseen.
uklotzde marked this conversation as resolved.
Show resolved Hide resolved
pub fn mark_unseen(&mut self) {
pub fn mark_changed(&mut self) {
self.version.decrement();
}

Expand Down
12 changes: 6 additions & 6 deletions tokio/tests/sync_watch.rs
View file
Open in desktop
Expand Up @@ -49,19 +49,19 @@ fn rx_version_underflow() {
let (_tx, mut rx) = watch::channel("one");

// Version starts at 2, validate we do not underflow
rx.mark_unseen();
rx.mark_unseen();
rx.mark_changed();
rx.mark_changed();
}

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

let mut rx2 = rx.clone();
let mut rx3 = rx.clone();
let mut rx4 = rx.clone();
{
rx.mark_unseen();
rx.mark_changed();
assert!(rx.has_changed().unwrap());

let mut t = spawn(rx.changed());
Expand All @@ -76,7 +76,7 @@ fn rx_mark_unseen() {
}

{
rx3.mark_unseen();
rx3.mark_changed();
assert_eq!(*rx3.borrow(), "one");

assert!(rx3.has_changed().unwrap());
Expand All @@ -94,7 +94,7 @@ fn rx_mark_unseen() {
assert!(rx4.has_changed().unwrap());
assert_eq!(*rx4.borrow_and_update(), "two");

rx4.mark_unseen();
rx4.mark_changed();
assert!(rx4.has_changed().unwrap());
assert_eq!(*rx4.borrow_and_update(), "two")
}
Expand Down