Clarify copyTo behavior in the documentation

Kotlin · Jun 23, 2023 · 5171a28 · 5171a28
1 parent 2b7eb60
commit 5171a28
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/core/common/src/Buffer.kt b/core/common/src/Buffer.kt
@@ -205,6 +205,7 @@ public class Buffer : Source, Sink {
 
   /**
    * Copy bytes from this buffer's subrange starting at [startIndex] and ending at [endIndex], to [out] buffer.
+   * This method does not consume data from the buffer.
    *
    * @param out the destination buffer to copy data into.
    * @param startIndex the index (inclusive) of the first byte of data in this buffer to copy,

diff --git a/core/jvm/src/BufferExtJvm.kt b/core/jvm/src/BufferExtJvm.kt
@@ -105,7 +105,8 @@ public fun Buffer.readTo(out: OutputStream, byteCount: Long = size) {
 }
 
 /**
- * Copy bytes from this buffer's subrange, starting at [startIndex] and ending at [endIndex], to [out].
+ * Copy bytes from this buffer's subrange, starting at [startIndex] and ending at [endIndex], to [out]. This method
+ * does not consume data from the buffer.
  *
  * @param out the destination to copy data into.
  * @param startIndex the index (inclusive) of the first byte to copy, `0` by default.