kotlinx-io-core/kotlinx.io.files

Package-level declarations

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Basic API for working with files.

Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

Known issues

#312 For wasmWasi target, directory listing (kotlinx.io.files.FileSystem.list) does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Types

FileMetadata

class FileMetadata(val isRegularFile: Boolean = false, val isDirectory: Boolean = false, val size: Long = 0)

Represents information about a file or directory obtainable from a filesystem like a type of filesystem node (is it a directory or a file?), its size, and so on.

FileNotFoundException

expect class FileNotFoundException(message: String?) : IOException

Signals an I/O operation's failure due to a missing file or directory.

actual typealias FileNotFoundException = java.io.FileNotFoundException

actual open class FileNotFoundException(message: String?) : IOException

FileSystem

sealed interface FileSystem

An interface providing basic operations on a filesystem, such as reading and writing files, creating directories, gathering file metadata and so on.

Path

expect class Path

A wrapper around a string representing a file path allowing to read from and write to a corresponding file using Sink and Source.

actual class Path

Properties

SystemFileSystem

expect val SystemFileSystem: FileSystem

An instance of FileSystem representing a default system-wide filesystem.

@JvmField

actual val SystemFileSystem: FileSystem

An instance of FileSystem representing a default system-wide filesystem.

SystemPathSeparator

expect val SystemPathSeparator: Char

A platform-specific character separating parts of the path. It's inherited from the default system's filesystem. It should not be used if an application is working with multiple filesystems having different separators.

@JvmField

actual val SystemPathSeparator: Char