warning on readerat

ipld · Mar 3, 2022 · e0f4c23 · e0f4c23
1 parent 5a41f7f
commit e0f4c23
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/traversal/selector/matcher_util.go b/traversal/selector/matcher_util.go
@@ -6,6 +6,10 @@ type readerat struct {
 	io.ReadSeeker
 }
 
+// ReadAt provides the io.ReadAt method over a ReadSeeker.
+// This implementation does not support concurrent calls to `ReadAt`,
+// as specified by the ReaderAt interface, and so must only be used
+// in non-concurrent use cases.
 func (r readerat) ReadAt(p []byte, off int64) (n int, err error) {
 	// TODO: consider keeping track of current offset.
 	_, err = r.Seek(off, 0)