Skip to content

Fix ambiguity in TcpStream::try_write_vectored docs#7067

Merged
Darksonn merged 1 commit intomasterfrom
unknown repository
Jan 6, 2025
Merged

Fix ambiguity in TcpStream::try_write_vectored docs#7067
Darksonn merged 1 commit intomasterfrom
unknown repository

Conversation

@ghost
Copy link
Copy Markdown

@ghost ghost commented Jan 4, 2025

Motivation

The buffer cannot be possible.

Solution

Make it clear that the last buffer that is read from by the method, may have only been partially read.

As a side note, does the method override the buffers' contents? If not, then "consumed" should be replaced with "written".

@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate M-net Module: tokio/net labels Jan 6, 2025
Copy link
Copy Markdown
Member

@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.

@Darksonn Darksonn merged commit 67f1277 into tokio-rs:master Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant