Skip to content

Commit 103d7bf

Browse files
authored
Remove incorrect guarantee for chunks_vectored (#754)
1 parent 16cc574 commit 103d7bf

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/buf/buf_impl.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -164,12 +164,12 @@ pub trait Buf {
164164
/// fetching more than one slice at once. `dst` is a slice of `IoSlice`
165165
/// references, enabling the slice to be directly used with [`writev`]
166166
/// without any further conversion. The sum of the lengths of all the
167-
/// buffers in `dst` will be less than or equal to `Buf::remaining()`.
167+
/// buffers written to `dst` will be less than or equal to `Buf::remaining()`.
168168
///
169169
/// The entries in `dst` will be overwritten, but the data **contained** by
170-
/// the slices **will not** be modified. If `chunk_vectored` does not fill every
171-
/// entry in `dst`, then `dst` is guaranteed to contain all remaining slices
172-
/// in `self.
170+
/// the slices **will not** be modified. The return value is the number of
171+
/// slices written to `dst`. If `Buf::remaining()` is non-zero, then this
172+
/// writes at least one non-empty slice to `dst`.
173173
///
174174
/// This is a lower level function. Most operations are done with other
175175
/// functions.

0 commit comments

Comments
 (0)