file/io.matthewnelson.kmp.file

Package-level declarations

Types

object ANDROID

value class Buffer

If printing to console, use unwrap beforehand, otherwise will not print the contents of buffer_Buffer.

DelicateFileApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class DelicateFileApi

Denotes an api as being delicate. Probably shouldn't use it.

expect open class EOFException : IOException

actual typealias EOFException = java.io.EOFException

actual open class EOFException : IOException

expect class File(pathname: String) : Comparable<File>

A File

actual typealias File = java.io.File

actual class File(pathname: String) : Comparable<File>

FileNotFoundException

expect open class FileNotFoundException : IOException

actual typealias FileNotFoundException = java.io.FileNotFoundException

actual open class FileNotFoundException : IOException

InterruptedException

expect open class InterruptedException : Exception

actual typealias InterruptedException = java.lang.InterruptedException

actual open class InterruptedException : Exception

expect open class IOException : Exception

actual typealias IOException = java.io.IOException

actual open class IOException : Exception

value class Stats

Properties

@get:JvmName(name = "absoluteFileOf")

val File.absoluteFile: File

absolutePath but returns a file

@get:JvmName(name = "absolutePathOf")

val File.absolutePath: String

Returns the absolute pathname string of this abstract pathname.

errorCodeOrNull

val Throwable.errorCodeOrNull: String?

@get:JvmName(name = "nameOf")

val File.name: String

The name of the file or directory. The last segment of the path.

@get:JvmName(name = "parentFileOf")

val File.parentFile: File?

The path parent. If no parent is available, null is returned.

@get:JvmName(name = "parentPathOf")

val File.parentPath: String?

The path parent. If no parent is available, null is returned.

@get:JvmName(name = "pathOf")

val File.path: String

The abstract path to a directory or file

@JvmField

val SysDirSep: Char

The operating system's directory separator character.

@JvmField

val SysTempDir: File

The system's temporary directory

Functions

@JvmName(name = "canonicalFileOf")

fun File.canonicalFile(): File

canonicalPath but returns a file

@JvmName(name = "canonicalPathOf")

fun File.canonicalPath(): String

Returns the canonical pathname string of this abstract pathname.

errnoToIOException

fun errnoToIOException(errno: Int): IOException

@DelicateFileApi

inline fun <T> File.fOpen(flags: String, block: (file: CPointer<FILE>) -> T): T

Opens the File, closing it automatically once block completes.

@DelicateFileApi

fun CPointer<FILE>.fRead(buf: ByteArray): Int

Reads the contents of FILE into provided ByteArray.

@DelicateFileApi

fun CPointer<FILE>.fWrite(buf: ByteArray, offset: Int = 0, len: Int = buf.size): Int

Writes buf to FILE

fun File.lstat(): Stats

@JvmName(name = "normalizedFileOf")

fun File.normalize(): File

Removes all . and resolves all possible .. for the provided path.

fun File.read(): Buffer

@JvmName(name = "readBytesFrom")

fun File.readBytes(): ByteArray

Read the full contents of the file (as bytes).

@JvmName(name = "readUtf8From")

fun File.readUtf8(): String

Read the full contents of the file (as UTF-8 text).

fun File.resolve(relative: File): File

Resolves the File for provided relative. If relative is absolute, returns relative, otherwise will concatenate the File.paths.

fun File.resolve(relative: String): File

fun File.stat(): Stats

@JvmName(name = "get")

fun String.toFile(): File

fun Throwable.toIOException(): IOException

wrapIOException

@JvmName(name = "wrapIO")

fun Throwable.wrapIOException(): IOException

Ensures that the throwable is an instance of IOException. If it is not, it will encase it in one.

@JvmName(name = "wrapIO")

fun Throwable.wrapIOException(lazyMessage: () -> String): IOException

Ensures that the throwable is an instance of IOException. If it is not, it will encase it in one with the provided lazyMessage.

fun File.write(data: Buffer)

@JvmName(name = "writeBytesTo")

fun File.writeBytes(array: ByteArray)

Writes the full contents of array to the file

@JvmName(name = "writeUtf8To")

fun File.writeUtf8(text: String)

Writes the full contents of text to the file (as UTF-8)