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 examples for FramedRead and FramedWrite #6310

Merged
merged 10 commits into from
Feb 10, 2024
Merged

util: add examples for FramedRead and FramedWrite #6310

merged 10 commits into from
Feb 10, 2024

Conversation

maminrayej
Copy link
Member

Resolves #6299.

@maminrayej maminrayej added T-docs Topic: documentation A-tokio-util Area: The tokio-util crate M-codec Module: tokio-util/codec labels Jan 26, 2024
Darksonn
Darksonn reviewed Jan 27, 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.

These examples are good, but I want something on the tokio_util::codec module as well. Preferably at the top, before the current examples. And I'd like it to go into more details explaining that the StreamExt import is needed to call next and the like.

Darksonn
Darksonn reviewed Jan 29, 2024
View reviewed changes
Darksonn
Darksonn reviewed Jan 30, 2024
View reviewed changes
maminrayej and others added 4 commits January 30, 2024 13:21
@maminrayej @Darksonn
Update tokio-util/src/codec/mod.rs
50eba17 
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
@maminrayej @Darksonn
Update tokio-util/src/codec/mod.rs
a37eefe 
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
@maminrayej
fix docs
7e2b9fa
@maminrayej
fix fmt
efaf220
Darksonn
Darksonn approved these changes Feb 10, 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.

Sorry about the delay.

@maminrayej maminrayej merged commit e25d661 into tokio-rs:master Feb 10, 2024
75 checks passed
@Darksonn Darksonn mentioned this pull request May 4, 2024
Merged
@maminrayej maminrayej deleted the document-framed-rw branch January 18, 2025 13:10
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.

Codecs documentation could use some fully formed examples
2 participants
@maminrayej @Darksonn