Visitar URL original
chore(runtime): add `is_finished` method for `JoinHandle` and `AbortHandle` by name1e5s · Pull Request #4709 · tokio-rs/tokio · GitHub
Skip to content

chore(runtime): add is_finished method for JoinHandle and AbortHandle - #4709

Merged
Darksonn merged 7 commits into
tokio-rs:masterfrom
name1e5s:feat/is_finished
May 31, 2022
Merged

chore(runtime): add is_finished method for JoinHandle and AbortHandle#4709
Darksonn merged 7 commits into
tokio-rs:masterfrom
name1e5s:feat/is_finished

Conversation

@name1e5s

@name1e5s name1e5s commented May 21, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Motivation

add is_finished method for JoinHandle and AbortHandle .
Close #4707

Solution

Check task's state is whether COMPLETE or CANCELLED.

@Darksonn Darksonn added A-tokio Area: The main tokio crate M-task Module: tokio/task labels May 21, 2022
Darksonn
Darksonn reviewed May 21, 2022
View reviewed changes
Comment thread tokio/src/runtime/task/join.rs
Comment on lines +229 to +233
pub fn is_finished(&self) -> bool {
if let Some(raw) = self.raw {
let state = raw.header().state.load();
state.is_complete() || state.is_cancelled()
} else {

@Darksonn Darksonn May 21, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hmm, I'm not so sure we want to use the is_cancelled() bit. The only situation where is_cancelled() is true but is_complete() is false is if abort has been called, but the task has not yet actually been cancelled.

@name1e5s name1e5s May 21, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

if COMPLETED is set when the task is cancelled, I think it's better to check is_complete only, as users can expect the handle is Ready when polled if is_finished returns true.

renancloudwalk
renancloudwalk reviewed May 21, 2022
View reviewed changes

@renancloudwalk renancloudwalk left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I might be wrong, but I think it would be good to implement this on fmt for Snapshot as well

Darksonn
Darksonn reviewed May 21, 2022
View reviewed changes
Comment thread tokio/src/runtime/task/join.rs Outdated
Comment thread tokio/src/runtime/task/join.rs Outdated
@Darksonn

Darksonn commented May 21, 2022

Copy link
Copy Markdown
Member

@renancloudwalk It's already there. It's the is_complete field.

Darksonn
Darksonn reviewed May 21, 2022
View reviewed changes
Comment thread tokio/src/runtime/task/join.rs Outdated
Darksonn
Darksonn reviewed May 22, 2022
View reviewed changes
Comment thread tokio/src/runtime/task/abort.rs Outdated
Darksonn
Darksonn reviewed May 22, 2022
View reviewed changes
Comment thread tokio/src/runtime/task/join.rs
Darksonn
Darksonn reviewed May 31, 2022
View reviewed changes

@Darksonn Darksonn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I have a comment on the documentation. Otherwise this looks good.

Comment thread tokio/src/runtime/task/join.rs
@Darksonn
Darksonn enabled auto-merge (squash) May 31, 2022 09:04
@Darksonn

Darksonn commented May 31, 2022

Copy link
Copy Markdown
Member

Thanks!

@Darksonn
Darksonn merged commit 83d0e7f into tokio-rs:master May 31, 2022
@Darksonn Darksonn mentioned this pull request Jun 3, 2022
Merged
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Jun 11, 2022
Calciumdibromid Bot cabr2-bot crapStone
Update Rust crate tokio to 1.19.1 (#1394)
d602dbd 
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [tokio](https://tokio.rs) ([source](https://github.com/tokio-rs/tokio)) | dependencies | minor | `1.18.2` -> `1.19.1` |
| [tokio](https://tokio.rs) ([source](https://github.com/tokio-rs/tokio)) | dev-dependencies | minor | `1.18.2` -> `1.19.1` |

---

### Release Notes

<details>
<summary>tokio-rs/tokio</summary>

### [`v1.19.1`](https://github.com/tokio-rs/tokio/releases/tag/tokio-1.19.1)

[Compare Source](tokio-rs/tokio@tokio-1.19.0...tokio-1.19.1)

##### 1.19.1 (June 5, 2022)

This release fixes a bug in `Notified::enable`. ([#&#8203;4747])

[#&#8203;4747]: tokio-rs/tokio#4747

### [`v1.19.0`](https://github.com/tokio-rs/tokio/releases/tag/tokio-1.19.0)

[Compare Source](tokio-rs/tokio@tokio-1.18.2...tokio-1.19.0)

##### 1.19.0 (June 3, 2022)

##### Added

-   runtime: add `is_finished` method for `JoinHandle` and `AbortHandle` ([#&#8203;4709])
-   runtime: make global queue and event polling intervals configurable ([#&#8203;4671])
-   sync: add `Notified::enable` ([#&#8203;4705])
-   sync: add `watch::Sender::send_if_modified` ([#&#8203;4591])
-   sync: add resubscribe method to broadcast::Receiver ([#&#8203;4607])
-   net: add `take_error` to `TcpSocket` and `TcpStream` ([#&#8203;4739])

##### Changed

-   io: refactor out usage of Weak in the io handle ([#&#8203;4656])

##### Fixed

-   macros: avoid starvation in `join!` and `try_join!` ([#&#8203;4624])

##### Documented

-   runtime: clarify semantics of tasks outliving `block_on` ([#&#8203;4729])
-   time: fix example for `MissedTickBehavior::Burst` ([#&#8203;4713])

##### Unstable

-   metrics: correctly update atomics in `IoDriverMetrics` ([#&#8203;4725])
-   metrics: fix compilation with unstable, process, and rt, but without net ([#&#8203;4682])
-   task: add `#[track_caller]` to `JoinSet`/`JoinMap` ([#&#8203;4697])
-   task: add `Builder::{spawn_on, spawn_local_on, spawn_blocking_on}` ([#&#8203;4683])
-   task: add `consume_budget` for cooperative scheduling ([#&#8203;4498])
-   task: add `join_set::Builder` for configuring `JoinSet` tasks ([#&#8203;4687])
-   task: update return value of `JoinSet::join_one` ([#&#8203;4726])

[#&#8203;4498]: tokio-rs/tokio#4498

[#&#8203;4591]: tokio-rs/tokio#4591

[#&#8203;4607]: tokio-rs/tokio#4607

[#&#8203;4624]: tokio-rs/tokio#4624

[#&#8203;4656]: tokio-rs/tokio#4656

[#&#8203;4671]: tokio-rs/tokio#4671

[#&#8203;4682]: tokio-rs/tokio#4682

[#&#8203;4683]: tokio-rs/tokio#4683

[#&#8203;4687]: tokio-rs/tokio#4687

[#&#8203;4697]: tokio-rs/tokio#4697

[#&#8203;4705]: tokio-rs/tokio#4705

[#&#8203;4709]: tokio-rs/tokio#4709

[#&#8203;4713]: tokio-rs/tokio#4713

[#&#8203;4725]: tokio-rs/tokio#4725

[#&#8203;4726]: tokio-rs/tokio#4726

[#&#8203;4729]: tokio-rs/tokio#4729

[#&#8203;4739]: tokio-rs/tokio#4739

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [x] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1394
Reviewed-by: crapStone <crapstone@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@coderabbitai coderabbitai Bot mentioned this pull request Apr 1, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Darksonn Darksonn Darksonn approved these changes
+1 more reviewer
@renancloudwalk renancloudwalk renancloudwalk left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-tokio Area: The main tokio crate M-task Module: tokio/task

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add JoinHandle::is_finished

3 participants

@name1e5s @Darksonn @renancloudwalk