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

This commit was moved from ipfs/go-ipfs-files@0889edb
ipfs · Aug 31, 2022 · 7418db2 · 7418db2
1 parent 4ebe090
commit 7418db2
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/files/file.go b/files/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:
 	//