async/io.matthewnelson.kmp.file.async

Package-level declarations

Types

expect open class AsyncFs

A contextual reference which provides access to a secondary, asynchronous implementation of the kmp-file:file API. On Jvm/Native, the synchronous kmp-file:file functions are simply called within the provided ctx (such as a background dispatcher). On Js/WasmJs, the kmp-file:file module exposes via InternalFileApi JavaScript's asynchronous callback API which is used in lieu of its synchronous API, which is called within the provided ctx.

actual open class AsyncFs

Functions

absoluteFile2

suspend fun AsyncFs.absoluteFile2(file: File): File

An asynchronous version of io.matthewnelson.kmp.file.absoluteFile2.

absolutePath2

suspend fun AsyncFs.absolutePath2(file: File): String

An asynchronous version of io.matthewnelson.kmp.file.absolutePath2.

append

inline suspend fun AsyncFs.append(file: File, excl: OpenExcl?, data: Buffer)

An asynchronous version of io.matthewnelson.kmp.file.append.

inline suspend fun AsyncFs.append(file: File, excl: OpenExcl?, src: ByteBuffer): Int

An asynchronous version of io.matthewnelson.kmp.file.append.

appendBytes

inline suspend fun AsyncFs.appendBytes(file: File, excl: OpenExcl?, array: ByteArray): File

An asynchronous version of io.matthewnelson.kmp.file.appendBytes.

appendUtf8

inline suspend fun AsyncFs.appendUtf8(file: File, excl: OpenExcl?, text: String): File

An asynchronous version of io.matthewnelson.kmp.file.appendUtf8.

canonicalFile2

suspend fun AsyncFs.canonicalFile2(file: File): File

An asynchronous version of io.matthewnelson.kmp.file.canonicalFile2.

canonicalPath2

suspend fun AsyncFs.canonicalPath2(file: File): String

An asynchronous version of io.matthewnelson.kmp.file.canonicalPath2.

chmod2

@JvmOverloads

suspend fun AsyncFs.chmod2(file: File, mode: String, mustExist: Boolean = true): File

An asynchronous version of io.matthewnelson.kmp.file.chmod2.

closeAsync

suspend fun FileStream.closeAsync()

An asynchronous version of FileStream.close. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead. Additionally, this function uses the NonCancellable job for withContext to ensure closure is always had.

delete2

@JvmOverloads

suspend fun AsyncFs.delete2(file: File, ignoreReadOnly: Boolean = false, mustExist: Boolean = false): File

An asynchronous version of io.matthewnelson.kmp.file.delete2.

exists2

suspend fun AsyncFs.exists2(file: File): Boolean

An asynchronous version of io.matthewnelson.kmp.file.exists2.

lstat

suspend fun AsyncFs.lstat(file: File): Stats

An asynchronous version of io.matthewnelson.kmp.file.lstat.

mkdir2

@JvmOverloads

suspend fun AsyncFs.mkdir2(dir: File, mode: String?, mustCreate: Boolean = false): File

An asynchronous version of io.matthewnelson.kmp.file.mkdir2.

mkdirs2

@JvmOverloads

suspend fun AsyncFs.mkdirs2(dir: File, mode: String?, mustCreate: Boolean = false): File

An asynchronous version of io.matthewnelson.kmp.file.mkdirs2.

openAppend

inline suspend fun AsyncFs.openAppend(file: File, excl: OpenExcl?): FileStream.Write

An asynchronous version of io.matthewnelson.kmp.file.openAppend.

openRead

suspend fun AsyncFs.openRead(file: File): FileStream.Read

An asynchronous version of io.matthewnelson.kmp.file.openRead.

openReadWrite

suspend fun AsyncFs.openReadWrite(file: File, excl: OpenExcl?): FileStream.ReadWrite

An asynchronous version of io.matthewnelson.kmp.file.openReadWrite.

openWrite

inline suspend fun AsyncFs.openWrite(file: File, excl: OpenExcl?): FileStream.Write

suspend fun AsyncFs.openWrite(file: File, excl: OpenExcl?, appending: Boolean): FileStream.Write

An asynchronous version of io.matthewnelson.kmp.file.openWrite.

positionAsync

suspend fun FileStream.positionAsync(): Long

suspend fun <S : FileStream> S.positionAsync(new: Long): S

An asynchronous version of FileStream.position. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

read

suspend fun AsyncFs.read(file: File): Buffer

An asynchronous version of io.matthewnelson.kmp.file.read.

suspend fun AsyncFs.read(file: File): ByteBuffer

An asynchronous version of io.matthewnelson.kmp.file.read.

readAsync

inline suspend fun FileStream.Read.readAsync(buf: ByteArray): Int

inline suspend fun FileStream.Read.readAsync(buf: ByteArray, position: Long): Int

suspend fun FileStream.Read.readAsync(buf: ByteArray, offset: Int, len: Int): Int

suspend fun FileStream.Read.readAsync(buf: ByteArray, offset: Int, len: Int, position: Long): Int

An asynchronous version of FileStream.Read.read. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

inline suspend fun FileStream.Read.readAsync(buf: Buffer): Long

inline suspend fun FileStream.Read.readAsync(buf: Buffer, position: Long): Long

suspend fun FileStream.Read.readAsync(buf: Buffer, offset: Long, len: Long): Long

suspend fun FileStream.Read.readAsync(buf: Buffer, offset: Long, len: Long, position: Long): Long

An asynchronous version of FileStream.Read.read. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

suspend fun FileStream.Read.readAsync(dst: ByteBuffer?): Int

suspend fun FileStream.Read.readAsync(dst: ByteBuffer?, position: Long): Int

An asynchronous version of FileStream.Read.read. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

readBytes

suspend fun AsyncFs.readBytes(file: File): ByteArray

An asynchronous version of io.matthewnelson.kmp.file.readBytes.

readUtf8

suspend fun AsyncFs.readUtf8(file: File): String

An asynchronous version of io.matthewnelson.kmp.file.readUtf8.

sizeAsync

suspend fun FileStream.sizeAsync(): Long

An asynchronous version of FileStream.size. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

suspend fun <S : FileStream.Write> S.sizeAsync(new: Long): S

An asynchronous version of FileStream.Write.size. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

stat

suspend fun AsyncFs.stat(file: File): Stats

An asynchronous version of io.matthewnelson.kmp.file.stat.

syncAsync

suspend fun <S : FileStream> S.syncAsync(meta: Boolean): S

An asynchronous version of FileStream.sync. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

useAsync

inline suspend fun <S : FileStream?, R> S.useAsync(block: (S) -> R): R

An asynchronous version of io.matthewnelson.kmp.file.use whereby closeAsync is called in lieu of FileStream.close.

with

inline fun <R> AsyncFs.with(block: AsyncFs.() -> R): R

All AsyncFs function implementations are top-level extension functions. This provides a way for callers to easily switch context where File extension functions can be used, matching the syntax of kmp-file:file's synchronous API.

write

inline suspend fun AsyncFs.write(file: File, excl: OpenExcl?, data: Buffer)

suspend fun AsyncFs.write(file: File, excl: OpenExcl?, appending: Boolean, data: Buffer)

An asynchronous version of io.matthewnelson.kmp.file.write.

inline suspend fun AsyncFs.write(file: File, excl: OpenExcl?, src: ByteBuffer): Int

suspend fun AsyncFs.write(file: File, excl: OpenExcl?, appending: Boolean, src: ByteBuffer): Int

An asynchronous version of io.matthewnelson.kmp.file.write.

writeAsync

inline suspend fun FileStream.Write.writeAsync(buf: ByteArray)

inline suspend fun FileStream.Write.writeAsync(buf: ByteArray, position: Long)

suspend fun FileStream.Write.writeAsync(buf: ByteArray, offset: Int, len: Int)

suspend fun FileStream.Write.writeAsync(buf: ByteArray, offset: Int, len: Int, position: Long)

An asynchronous version of FileStream.Write.write. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

inline suspend fun FileStream.Write.writeAsync(buf: Buffer)

inline suspend fun FileStream.Write.writeAsync(buf: Buffer, position: Long)

suspend fun FileStream.Write.writeAsync(buf: Buffer, offset: Long, len: Long)

suspend fun FileStream.Write.writeAsync(buf: Buffer, offset: Long, len: Long, position: Long)

An asynchronous version of FileStream.Write.write. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

writeBytes

inline suspend fun AsyncFs.writeBytes(file: File, excl: OpenExcl?, array: ByteArray): File

suspend fun AsyncFs.writeBytes(file: File, excl: OpenExcl?, appending: Boolean, array: ByteArray): File

An asynchronous version of io.matthewnelson.kmp.file.writeBytes.

writesAsync

suspend fun FileStream.Write.writesAsync(src: ByteBuffer?): Int

suspend fun FileStream.Write.writesAsync(src: ByteBuffer?, position: Long): Int

An asynchronous version of FileStream.Write.write. If FileStream was not opened using AsyncFs, thus not inheriting its CoroutineContext, then the default AsyncFs.ctx will be used instead.

writeUtf8

inline suspend fun AsyncFs.writeUtf8(file: File, excl: OpenExcl?, text: String): File

suspend fun AsyncFs.writeUtf8(file: File, excl: OpenExcl?, appending: Boolean, text: String): File

An asynchronous version of io.matthewnelson.kmp.file.writeUtf8.