From: Brad Fitzpatrick <bradfitz@golang.org>
Date: Wed, 7 Mar 2012 18:54:04 +0000 (-0800)
Subject: io: more docs on WriterAt
X-Git-Tag: weekly.2012-03-13~127
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=0210f4137b97b0e66c92b5f89a957085293670d5;p=gostls13.git

io: more docs on WriterAt

Updates #1599

R=golang-dev, gri, rsc
CC=golang-dev
https://golang.org/cl/5774043
---

diff --git a/src/pkg/io/io.go b/src/pkg/io/io.go
index 7074834d61..629b9fb75f 100644
--- a/src/pkg/io/io.go
+++ b/src/pkg/io/io.go
@@ -173,6 +173,13 @@ type ReaderAt interface {
 // at offset off.  It returns the number of bytes written from p (0 <= n <= len(p))
 // and any error encountered that caused the write to stop early.
 // WriteAt must return a non-nil error if it returns n < len(p).
+//
+// If WriteAt is writing to a destination with a seek offset,
+// WriteAt should not affect nor be affected by the underlying
+// seek offset.
+//
+// Clients of WriteAt can execute parallel WriteAt calls on the same
+// destination if the ranges are not overlapping.
 type WriterAt interface {
 	WriteAt(p []byte, off int64) (n int, err error)
 }