Skip to content

task: clarify the behavior of several spawn_local methods #7669

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
Merged
merged 7 commits into from
Oct 12, 2025
Merged

task: clarify the behavior of several spawn_local methods #7669

merged 7 commits into from
Oct 12, 2025
+24 −15

Conversation

@mattiapitossi
Copy link
Contributor

fixes #7561

@ADD-SP ADD-SP added A-tokio-util Area: The tokio-util crate A-tokio Area: The main tokio crate M-task Module: tokio/task labels Oct 11, 2025
Darksonn
Darksonn reviewed Oct 11, 2025
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

tokio-util/src/task/join_map.rs Outdated
Comment on lines 347 to 349

/// Spawn the provided task on the current [`LocalSet`] and store it in this
/// Spawn the provided task on the current [`LocalSet`] or [`LocalRuntime`] and store it in this
/// `JoinMap` with the provided key.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please try to keep the line length consistent with the rest of the file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review, I fixed the formatting, let me know if now it makes sense to you

@ADD-SP
Copy link
Member

ADD-SP commented Oct 11, 2025

tokio/tokio-util/src/task/join_queue.rs

Line 106 in e7e02fc

pub fn spawn_local<F>(&mut self, task: F) -> AbortHandle

Could you also update the docs of JoinQueue?

@ADD-SP ADD-SP added the T-docs Topic: documentation label Oct 11, 2025
@mattiapitossi
Copy link
Contributor Author

tokio/tokio-util/src/task/join_queue.rs

Line 106 in e7e02fc

pub fn spawn_local<F>(&mut self, task: F) -> AbortHandle

Could you also update the docs of JoinQueue?

Sure @ADD-SP, added also for join_queue

ADD-SP
ADD-SP approved these changes Oct 11, 2025
View reviewed changes
Copy link
Member

@ADD-SP ADD-SP left a comment

Choose a reason for hiding this comment

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

Thanks!

@ADD-SP ADD-SP changed the title Clarify the behavior of several spawn_local methods tasl: clarify the behavior of several spawn_local methods Oct 12, 2025
@ADD-SP ADD-SP changed the title tasl: clarify the behavior of several spawn_local methods task: clarify the behavior of several spawn_local methods Oct 12, 2025
@ADD-SP ADD-SP merged commit c1fa25f into tokio-rs:master Oct 12, 2025
88 checks passed
@Darksonn Darksonn mentioned this pull request Oct 14, 2025
Merged
@mattiapitossi mattiapitossi mentioned this pull request Oct 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Darksonn Darksonn Darksonn left review comments

@ADD-SP ADD-SP ADD-SP approved these changes

Assignees

No one assigned

Labels

A-tokio Area: The main tokio crate A-tokio-util Area: The tokio-util crate M-task Module: tokio/task T-docs Topic: documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Clarify the behavior of several spawn_local methods

3 participants

@mattiapitossi @ADD-SP @Darksonn