Add comment about memory invalidation in Iterator.next on Win

ziglang · Jul 7, 2020 · 417c928 · 417c928
1 parent e7d02ea
commit 417c928
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/std/fs.zig b/lib/std/fs.zig
@@ -453,6 +453,8 @@ pub const Dir = struct {
 
             pub const Error = IteratorError;
 
+            /// Memory such as file names referenced in this returned entry becomes invalid
+            /// with subsequent calls to `next`, as well as when this `Dir` is deinitialized.
             pub fn next(self: *Self) Error!?Entry {
                 start_over: while (true) {
                     const w = os.windows;