File tree Expand file tree Collapse file tree 1 file changed +11
-2
lines changed Expand file tree Collapse file tree 1 file changed +11
-2
lines changed Original file line number Diff line number Diff line change @@ -10,7 +10,15 @@ import kotlinx.io.RawSink
10
10
import kotlinx.io.RawSource
11
11
12
12
/* *
13
- * An interface providing basic operations on a filesystem.
13
+ * An interface providing basic operations on a filesystem, such as reading and writing files,
14
+ * creating directories, gathering file metadata and so on.
15
+ *
16
+ * Default implementation of this interface is [SystemFileSystem]. It provides access to files and directories
17
+ * on disk.
18
+ *
19
+ * The interface is sealed until API stabilization, but in the future it will allow
20
+ * creating custom filesystems that could be used as mocks for testing or provide
21
+ * access to some network resources and allow working with them as with regular files, for example.
14
22
*
15
23
* **This API is unstable and subject to change.**
16
24
*/
@@ -138,7 +146,8 @@ public expect val SystemFileSystem: FileSystem
138
146
public expect val SystemTemporaryDirectory : Path
139
147
140
148
/* *
141
- * Represents information about a file or directory obtainable from a filesystem.
149
+ * Represents information about a file or directory obtainable from a filesystem like
150
+ * a type of filesystem node (is it a directory or a file?), its size, and so on.
142
151
*/
143
152
public class FileMetadata (
144
153
/* *
You can’t perform that action at this time.
0 commit comments