Skip to content

Commit 6129989

Browse files
committed
Improve filesystems documentation
1 parent df9f483 commit 6129989

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

core/common/src/files/FileSystem.kt

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,15 @@ import kotlinx.io.RawSink
1010
import kotlinx.io.RawSource
1111

1212
/**
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.
1422
*
1523
* **This API is unstable and subject to change.**
1624
*/
@@ -138,7 +146,8 @@ public expect val SystemFileSystem: FileSystem
138146
public expect val SystemTemporaryDirectory: Path
139147

140148
/**
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.
142151
*/
143152
public class FileMetadata(
144153
/**

0 commit comments

Comments
 (0)