From 103d7bf9e030fd4ce009092e8da8f2ff3251e261 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Fri, 10 Jan 2025 23:13:52 +0100 Subject: [PATCH] Remove incorrect guarantee for `chunks_vectored` (#754) --- src/buf/buf_impl.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/buf/buf_impl.rs b/src/buf/buf_impl.rs index b09d356bd..ab715e434 100644 --- a/src/buf/buf_impl.rs +++ b/src/buf/buf_impl.rs @@ -164,12 +164,12 @@ pub trait Buf { /// fetching more than one slice at once. `dst` is a slice of `IoSlice` /// references, enabling the slice to be directly used with [`writev`] /// without any further conversion. The sum of the lengths of all the - /// buffers in `dst` will be less than or equal to `Buf::remaining()`. + /// buffers written to `dst` will be less than or equal to `Buf::remaining()`. /// /// The entries in `dst` will be overwritten, but the data **contained** by - /// the slices **will not** be modified. If `chunk_vectored` does not fill every - /// entry in `dst`, then `dst` is guaranteed to contain all remaining slices - /// in `self. + /// the slices **will not** be modified. The return value is the number of + /// slices written to `dst`. If `Buf::remaining()` is non-zero, then this + /// writes at least one non-empty slice to `dst`. /// /// This is a lower level function. Most operations are done with other /// functions.