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 cancel safety of AsyncReadExt's primitive read functions #6332

Closed
Astralchroma opened this issue Feb 9, 2024 · 0 comments · Fixed by #6337
Closed

Document cancel safety of AsyncReadExt's primitive read functions #6332

Astralchroma opened this issue Feb 9, 2024 · 0 comments · Fixed by #6337
Labels
A-tokio Area: The main tokio crate C-feature-request Category: A feature request. M-io Module: tokio/io T-docs Topic: documentation

Comments

@Astralchroma
Copy link

Is your feature request related to a problem? Please describe.
The cancel safety of the primitive read functions (like read_u8) in AsyncReadExt is not documented.

Describe the solution you'd like
Document cancel safety.

Describe alternatives you've considered
It can be found by just searching online, but really it should be documented like other functions.
@Astralchroma Astralchroma added A-tokio Area: The main tokio crate C-feature-request Category: A feature request. labels Feb 9, 2024
@Darksonn Darksonn added T-docs Topic: documentation M-io Module: tokio/io labels Feb 9, 2024
@maminrayej maminrayej mentioned this issue Feb 11, 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-feature-request Category: A feature request. 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 AsyncReadExt's primitive read functions maminrayej/tokio
2 participants
@Darksonn @Astralchroma