File tree Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -132,6 +132,16 @@ pub struct ReadDir(fs_imp::ReadDir);
132132/// An instance of `DirEntry` represents an entry inside of a directory on the
133133/// filesystem. Each entry can be inspected via methods to learn about the full
134134/// path or possibly other metadata through per-platform extension traits.
135+ ///
136+ /// # Platform-specific behavior
137+ ///
138+ /// On Unix, the `DirEntry` struct contains an internal reference to the open
139+ /// directory. Holding `DirEntry` objects will consume a file handle even
140+ /// after the `ReadDir` iterator is dropped.
141+ ///
142+ /// Note that this [may change in the future][changes].
143+ ///
144+ /// [changes]: io#platform-specific-behavior
135145#[ stable( feature = "rust1" , since = "1.0.0" ) ]
136146pub struct DirEntry ( fs_imp:: DirEntry ) ;
137147
You can’t perform that action at this time.
0 commit comments