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

util: add documentation about cancel safety of SinkExt::send #6417

Merged
merged 6 commits into from Mar 24, 2024
Merged

util: add documentation about cancel safety of SinkExt::send #6417

merged 6 commits into from Mar 24, 2024

Conversation

maminrayej
Copy link
Member

Since types in different sub-modules in tokio-util implement Sink, I decided to put the doc in the top level module.

Resolves #5310.

@maminrayej maminrayej added T-docs Topic: documentation A-tokio-util Area: The tokio-util crate labels Mar 20, 2024
Darksonn
Darksonn reviewed Mar 23, 2024
View reviewed changes
tokio-util/src/lib.rs Outdated Show resolved Hide resolved
@Darksonn Darksonn added the M-codec Module: tokio-util/codec label Mar 23, 2024
Darksonn
Darksonn approved these changes Mar 24, 2024
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.

I think it would be good to add a similar comment about StreamExt::next. Whether you want to do that in this PR or not is up to you.

tokio-util/src/codec/framed_write.rs Outdated Show resolved Hide resolved
Darksonn
Darksonn approved these changes Mar 24, 2024
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.

Otherwise LGTM.

tokio-util/src/codec/framed_read.rs Outdated Show resolved Hide resolved
tokio-util/src/codec/framed_write.rs Outdated Show resolved Hide resolved
@maminrayej maminrayej merged commit deff252 into tokio-rs:master Mar 24, 2024
75 checks passed
@Darksonn Darksonn mentioned this pull request May 4, 2024
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

Assignees
No one assigned
Labels
A-tokio-util Area: The tokio-util crate M-codec Module: tokio-util/codec T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Tokio-util codec Framed - cancel safety
2 participants
@maminrayej @Darksonn