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

Document cancelation safety AsyncBufReadExt::fill_buf #6430

Closed
jkalez opened this issue Mar 25, 2024 · 1 comment · Fixed by #6431
Closed

Document cancelation safety AsyncBufReadExt::fill_buf #6430

jkalez opened this issue Mar 25, 2024 · 1 comment · Fixed by #6431
Labels
A-tokio Area: The main tokio crate C-bug Category: This is a bug. M-io Module: tokio/io T-docs Topic: documentation

Comments

@jkalez
Copy link

jkalez commented Mar 25, 2024

Version
1.36

Platform
All

Description
Documentation does not comment on the cancellation safety of AsyncBufReadExt::fill_buf. In my experimentation and in reading the source, I have not been able to determine the cancellation safety of fill_buf. Hopefully developers more familiar with the code can provide this information.
@jkalez jkalez added A-tokio Area: The main tokio crate C-bug Category: This is a bug. labels Mar 25, 2024
@Darksonn Darksonn added M-io Module: tokio/io T-docs Topic: documentation labels Mar 25, 2024
@Darksonn
Copy link
Contributor

Thanks. That should definitely be fixed. The method is cancellation safe.

@maminrayej maminrayej mentioned this issue Mar 25, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate C-bug Category: This is a bug. M-io Module: tokio/io T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

io: document cancel safety of AsyncBufReadExt::fill_buf maminrayej/tokio
2 participants
@Darksonn @jkalez