okio-nodefilesystem/okio/NodeJsFileSystem

NodeJsFileSystem

Use Node.js APIs to implement the Okio file system interface.

This class needs to make calls to some fs APIs that have multiple competing overloads. To unambiguously select an overload this passes undefined as the target type to some functions.

Functions

appendingSink

open override fun appendingSink(file: Path, mustExist: Boolean): Sink

atomicMove

open override fun atomicMove(source: Path, target: Path)

canonicalize

open override fun canonicalize(path: Path): Path

copy

open fun copy(source: Path, target: Path)

createDirectories

fun createDirectories(dir: Path, mustCreate: Boolean)

createDirectory

open override fun createDirectory(dir: Path, mustCreate: Boolean)

createSymlink

open override fun createSymlink(source: Path, target: Path)

delete

open override fun delete(path: Path, mustExist: Boolean)

We don't know if path is a file or a directory, but we don't (yet) have an API to delete either type. Just try each in sequence.

deleteRecursively

open fun deleteRecursively(fileOrDirectory: Path, mustExist: Boolean)

exists

fun exists(path: Path): Boolean

list

open override fun list(dir: Path): List<Path>

listOrNull

open override fun listOrNull(dir: Path): List<Path>?

listRecursively

open fun listRecursively(dir: Path, followSymlinks: Boolean): Sequence<Path>

metadata

fun metadata(path: Path): FileMetadata

metadataOrNull

open override fun metadataOrNull(path: Path): FileMetadata?

openReadOnly

open override fun openReadOnly(file: Path): FileHandle

openReadWrite

open override fun openReadWrite(file: Path, mustCreate: Boolean, mustExist: Boolean): FileHandle

read

inline fun <T> read(file: Path, readerAction: BufferedSource.() -> T): T

sink

open override fun sink(file: Path, mustCreate: Boolean): Sink

source

open override fun source(file: Path): Source

toString

open override fun toString(): String

write

inline fun <T> write(file: Path, mustCreate: Boolean, writerAction: BufferedSink.() -> T): T