kotlinx-io-core/kotlinx.io.files/FileSystem/list

list

abstract fun list(directory: Path): Collection<Path>(source)

Returns paths corresponding to directory's immediate children.

There are no guarantees on children paths order within a returned collection.

If path directory was an absolute path, a returned collection will also contain absolute paths. If it was a relative path, a returned collection will contain relative paths.

For wasmWasi target, function does not work with NodeJS runtime on Windows, as fd_readdir function is not implemented there.

Return

a collection of directory's immediate children.

Parameters

directory

a directory to list.

Throws

if directory does not exist.

if there was an underlying error preventing listing directory children.