korlibs-io-vfs/korlibs.io.file/VfsFile

VfsFile

data class VfsFile(val vfs: Vfs, val path: String) : VfsNamed, AsyncInputOpenable, Extra

Constructors

constructor(vfs: Vfs, path: String)

Types

data class ProcessResult(val exitCode: Int, val stdout: String, val stderr: String)

Properties

val absolutePath: String

absolutePathInfo

val absolutePathInfo: PathInfo

val Path.baseName: String

baseNameWithoutCompoundExtension

val Path.baseNameWithoutCompoundExtension: String

baseNameWithoutExtension

val Path.baseNameWithoutExtension: String

var cachedStat: VfsStat?

compoundExtension

val Path.compoundExtension: String

compoundExtensionLC

val Path.compoundExtensionLC: String

val Path.extension: String

val Path.extensionLC: String

open override var extra: ExtraType

val Path.folder: String

folderWithSlash

val Path.folderWithSlash: String

val Path.fullName: String

fullNameWithoutCompoundExtension

val Path.fullNameWithoutCompoundExtension: String

fullNameWithoutExtension

val Path.fullNameWithoutExtension: String

fullPathNormalized

val Path.fullPathNormalized: String

fullPathWithoutExtension

val Path.fullPathWithoutExtension: String

val parent: VfsFile

val path: String

open override val pathInfo: PathInfo

val root: VfsFile

val vfs: Vfs

Functions

appendExtension

fun appendExtension(ext: String): VfsFile

baseNameWithCompoundExtension

fun Path.baseNameWithCompoundExtension(ext: String): String

baseNameWithExtension

fun Path.baseNameWithExtension(ext: String): String

suspend fun VfsFile.cachedToMemory(): VfsFile

suspend fun chmod(mode: Vfs.UnixPermissions)

suspend fun copyTo(target: AsyncOutputStream): Long

suspend fun copyTo(target: VfsFile, vararg attributes: Vfs.Attribute): Long

copyToRecursively

suspend fun copyToRecursively(target: VfsFile, vararg attributes: Vfs.Attribute, notify: suspend (Pair<VfsFile, VfsFile>) -> Unit = {})

Copies this VfsFile into the target VfsFile.

suspend fun delete(): Boolean

deleteRecursively

suspend fun VfsFile.deleteRecursively(includeSelf: Boolean = true)

Deletes all the files in this folder recursively. If the entry is a file instead of a directory, the file is deleted.

suspend fun ensureParents(): VfsFile

suspend fun exec(cmdAndArgs: List<String>, env: Map<String, String> = LinkedHashMap(), handler: VfsProcessHandler = VfsProcessHandler()): Int

suspend fun execProcess(cmdAndArgs: List<String>, env: Map<String, String> = LinkedHashMap(), captureError: Boolean = false, charset: Charset = UTF8): VfsFile.ProcessResult

suspend fun execProcess(vararg cmdAndArgs: String, env: Map<String, String> = LinkedHashMap(), captureError: Boolean = false, charset: Charset = UTF8): VfsFile.ProcessResult

suspend fun execToString(vararg cmdAndArgs: String, charset: Charset = UTF8): String

suspend fun execToString(cmdAndArgs: List<String>, env: Map<String, String> = LinkedHashMap(), charset: Charset = UTF8, captureError: Boolean = false, throwOnError: Boolean = true): String

suspend fun exists(): Boolean

fullPathWithExtension

fun Path.fullPathWithExtension(ext: String): String

operator fun get(path: String): VfsFile

inline suspend fun <T : Vfs.Attribute> getAttribute(): T?

suspend fun getAttributes(): List<Vfs.Attribute>

getPathComponents

fun Path.getPathComponents(): List<String>

getPathFullComponents

fun Path.getPathFullComponents(): List<String>

getUnderlyingUnscapedFile

suspend fun VfsFile.getUnderlyingUnscapedFile(): FinalVfsFile

getUnixPermission

inline suspend fun VfsFile.getUnixPermission(): Vfs.UnixPermissions

isCaseSensitive

suspend fun isCaseSensitive(): Boolean

suspend fun isDirectory(): Boolean

suspend fun isFile(): Boolean

fun jail(): VfsFile

fun VfsFile.jail(): VfsFile

fun jailParent(): VfsFile

fun VfsFile.jailParent(): VfsFile

suspend fun list(): Flow<VfsFile>

suspend fun listNames(): List<String>

suspend fun listRecursive(filter: (VfsFile) -> Boolean = { true }): Flow<VfsFile>

listRecursiveSimple

suspend fun listRecursiveSimple(filter: (VfsFile) -> Boolean = { true }): List<VfsFile>

suspend fun listSimple(): List<VfsFile>

suspend fun mkdir(attributes: List<Vfs.Attribute>): Boolean

suspend fun mkdir(vararg attributes: Vfs.Attribute): Boolean

suspend fun mkdirs(attributes: List<Vfs.Attribute>): Boolean

suspend fun mkdirs(vararg attributes: Vfs.Attribute): Boolean

suspend fun open(mode: VfsOpenMode = VfsOpenMode.READ): AsyncStream

openInputStream

suspend fun openInputStream(): AsyncInputStream

open suspend override fun openRead(): AsyncStream

inline suspend fun <T> openUse(mode: VfsOpenMode = VfsOpenMode.READ, callback: AsyncStream.() -> T): T

inline suspend fun <T> openUseIt(mode: VfsOpenMode = VfsOpenMode.READ, callback: (AsyncStream) -> T): T

suspend fun passthru(cmdAndArgs: List<String>, env: Map<String, String> = LinkedHashMap(), charset: Charset = UTF8): Int

suspend fun passthru(vararg cmdAndArgs: String, env: Map<String, String> = LinkedHashMap(), charset: Charset = UTF8): Int

fun VfsFile.proxied(transform: suspend (VfsFile) -> VfsFile): VfsFile

suspend fun put(content: AsyncInputStream, attributes: List<Vfs.Attribute> = listOf()): Long

suspend fun put(content: AsyncInputStream, vararg attributes: Vfs.Attribute): Long

suspend fun read(): ByteArray

suspend fun readAll(): ByteArray

readAsSyncStream

suspend fun VfsFile.readAsSyncStream(): SyncStream

suspend fun readBytes(): ByteArray

suspend fun readChunk(offset: Long, size: Int): ByteArray

suspend fun readLines(charset: Charset = UTF8): Sequence<String>

suspend fun readRangeBytes(range: IntRange): ByteArray

suspend fun readRangeBytes(range: LongRange): ByteArray

suspend fun readString(charset: Charset = UTF8): String

suspend fun redirected(pathRedirector: suspend VfsFile.(String) -> String): VfsFile

fun relativePathTo(relative: VfsFile): String?

suspend fun rename(src: String, dst: String): Boolean

Renames the file determined by this plus src to this plus dst

suspend fun renameTo(dstPath: String): Boolean

Renames this file into the dstPath relative to the root of this vfs

suspend fun setAttributes(attributes: List<Vfs.Attribute>)

suspend fun setAttributes(vararg attributes: Vfs.Attribute)

suspend fun setSize(size: Long)

setUnixPermission

inline suspend fun VfsFile.setUnixPermission(permissions: Vfs.UnixPermissions)

suspend fun size(): Long

suspend fun stat(): VfsStat

suspend fun takeIfExists(): VfsFile?

open override fun toString(): String

suspend fun touch(time: DateTime, atime: DateTime = time)

fun VfsFile.toUnscaped(): FinalVfsFile

suspend fun <R> VfsFile.useVfs(callback: suspend (VfsFile) -> R): R

suspend fun watch(handler: suspend (Vfs.FileEvent) -> Unit): AutoCloseable

withCompoundExtension

fun withCompoundExtension(ext: String): VfsFile

fun withExtension(ext: String): VfsFile

fun VfsFile.withOnce(once: suspend (VfsFile) -> Unit): VfsFile

suspend fun write(data: ByteArray, vararg attributes: Vfs.Attribute): Long

suspend fun writeBytes(data: ByteArray, vararg attributes: Vfs.Attribute): Long

suspend fun writeChunk(data: ByteArray, offset: Long, resize: Boolean = false)

suspend fun writeFile(file: VfsFile, vararg attributes: Vfs.Attribute): Long

suspend fun writeLines(lines: Iterable<String>, charset: Charset = UTF8)

suspend fun writeStream(src: AsyncInputStream, vararg attributes: Vfs.Attribute, autoClose: Boolean = true): Long

suspend fun writeString(data: String, vararg attributes: Vfs.Attribute, charset: Charset = UTF8)