korge-core/korlibs.io.file/Vfs

Vfs

abstract class Vfs : AsyncCloseable

Inheritors

AndroidResourcesVfs

MapLikeStorageVfs

WindowsRegistryVfs

Constructors

constructor()

Types

interface Attribute

open class Decorator(val parent: VfsFile) : Vfs.Proxy

data class FileEvent(val kind: Vfs.FileEvent.Kind, val file: VfsFile, val other: VfsFile? = null)

interface FileKind : Vfs.Attribute

abstract class Proxy : Vfs

inline class UnixPermission(val bits: Int)

UnixPermissions

inline class UnixPermissions(val bits: Int) : Vfs.Attribute

Properties

val root: VfsFile

supportedAttributeTypes

open val supportedAttributeTypes: List<KClass<out Vfs.Attribute>>

Functions

open suspend fun chmod(path: String, mode: Vfs.UnixPermissions)

Change Unix Permissions for path to mode

open suspend override fun close()

createExistsStat

fun createExistsStat(path: String, isDirectory: Boolean, size: Long, device: Long = -1, inode: Long = -1, mode: Int = 511, owner: String = "nobody", group: String = "nobody", createTime: DateTime = DateTime.EPOCH, modifiedTime: DateTime = DateTime.EPOCH, lastAccessTime: DateTime = modifiedTime, extraInfo: Any? = null, id: String? = null, cache: Boolean = false): VfsStat

createNonExistsStat

fun createNonExistsStat(path: String, extraInfo: Any? = null, cache: Boolean = false): VfsStat

open suspend fun delete(path: String): Boolean

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

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

fun file(path: String): VfsFile

operator fun get(path: String): VfsFile

inline fun <T> Iterable<Vfs.Attribute>.get(): T?

getAbsolutePath

open fun getAbsolutePath(path: String): String

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

open fun getKind(value: Any?): Vfs.FileKind

inline fun <T : Vfs.Attribute> List<Vfs.Attribute>.getOrNull(): T?

getUnderlyingUnscapedFile

open suspend fun getUnderlyingUnscapedFile(path: String): FinalVfsFile

open suspend fun listFlow(path: String): Flow<VfsFile>

suspend fun listSimple(path: String): List<VfsFile>

open suspend fun mkdir(path: String, attributes: List<Vfs.Attribute>): Boolean

open suspend fun mkdirs(path: String, attributes: List<Vfs.Attribute>): Boolean

open suspend fun open(path: String, mode: VfsOpenMode): AsyncStream

openInputStream

open suspend fun openInputStream(path: String): AsyncInputStream

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

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

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

open suspend fun readRange(path: String, range: LongRange): ByteArray

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

open suspend fun rmdir(path: String): Boolean

open suspend fun setAttributes(path: String, attributes: List<Vfs.Attribute>)

open suspend fun setSize(path: String, size: Long)

open suspend fun stat(path: String): VfsStat

open override fun toString(): String

open suspend fun touch(path: String, time: DateTime, atime: DateTime)

open suspend fun watch(path: String, handler: (Vfs.FileEvent) -> Unit): Closeable

suspend fun writeChunk(path: String, data: ByteArray, offset: Long, resize: Boolean)