chore(Directory): add DirIterator API restriction: iterate only once

ipfs · Aug 31, 2022 · 0889edb · 0889edb
1 parent 88b4692
commit 0889edb
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/file.go b/file.go
@@ -63,7 +63,9 @@ type DirIterator interface {
 type Directory interface {
 	Node
 
-	// Entries returns a stateful iterator over directory entries.
+	// Entries returns a stateful iterator over directory entries. The iterator
+	// may consume the Directory state so it must be called only once (this
+	// applies specifically to the multipartIterator).
 	//
 	// Example usage:
 	//