korge-core/korlibs.io.file.std

Package-level declarations

Types

AndroidDeferredVfs

class AndroidDeferredVfs(generate: (Context) -> VfsFile) : Vfs.Proxy

AndroidResourcesVfs

class AndroidResourcesVfs : Vfs

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

DynamicRootVfsVfs

open class DynamicRootVfsVfs(val base: Vfs, val rootGet: () -> String) : Vfs.Proxy

object EmptyVfs : Vfs

object ISO

class IsoVfs(val iso: ISO.IsoFile, val closeStream: Boolean) : Vfs

class JailVfs : Vfs.Proxy

JvmClassLoaderResourcesVfs

class JvmClassLoaderResourcesVfs(val classLoader: ClassLoader) : MergedVfs

abstract class LocalVfs : Vfs

expect open class LocalVfsNative(val async: Boolean = true) : LocalVfsNativeBase

LocalVfsNativeBase

open class LocalVfsNativeBase(val async: Boolean = true) : LocalVfs

class LogVfs(val parent: VfsFile) : Vfs.Proxy

MapLikeStorageVfs

class MapLikeStorageVfs(val storage: SimpleStorage) : Vfs

class MemoryNodeTree(val caseSensitive: Boolean = true)

open class MergedVfs(vfsList: List<VfsFile> = listOf(), val name: String = "unknown") : Vfs.Proxy

interface Mountable

class MountableVfs(val closeMounts: Boolean) : Vfs.Proxy, Mountable

open class NodeVfs(val caseSensitive: Boolean = true) : Vfs

object ShellArgs

StandardBasePathsDarwin

open class StandardBasePathsDarwin : StandardBasePathsNative

StandardBasePathsNative

open class StandardBasePathsNative : StandardPathsBase

actual object StandardPaths : StandardPathsJvmAndroid, StandardPathsBase

expect object StandardPaths : StandardPathsBase

Contain standard paths to different parts of the operating system.

actual object StandardPaths : StandardBasePathsDarwin, StandardPathsBase

actual object StandardPaths : StandardPathsBase

actual object StandardPaths : StandardPathsJvmAndroid, StandardPathsBase

StandardPathsBase

interface StandardPathsBase

StandardPathsJvmAndroid

open class StandardPathsJvmAndroid : StandardPathsBase

open class StandardVfs

class UniSchema(val name: String, val provider: (URL) -> VfsFile)

UniSchemaProviders

class UniSchemaProviders(val providers: Map<String, UniSchema>)

object UniversalVfs

class UrlVfs(val url: String, val dummy: Unit, val client: HttpClient = createHttpClient(), val failFromStatus: Boolean = true) : Vfs

Properties

var absoluteCwd: String

applicationDataVfs

actual val applicationDataVfs: VfsFile

expect val applicationDataVfs: VfsFile

actual val applicationDataVfs: VfsFile

actual val applicationDataVfs: VfsFile

actual val applicationDataVfs: VfsFile

actual val applicationVfs: VfsFile

expect val applicationVfs: VfsFile

actual val applicationVfs: VfsFile

actual val applicationVfs: VfsFile

actual val applicationVfs: VfsFile

actual val cacheVfs: VfsFile

expect val cacheVfs: VfsFile

A Memory Virtual File System for cache

actual val cacheVfs: VfsFile

actual val cacheVfs: VfsFile

actual val cacheVfs: VfsFile

var customCwd: String?

val cwd: String

val cwdVfs: VfsFile

defaultUniSchema

var defaultUniSchema: UniSchemaProviders

externalStorageVfs

actual val externalStorageVfs: VfsFile

expect val externalStorageVfs: VfsFile

actual val externalStorageVfs: VfsFile

actual val externalStorageVfs: VfsFile

actual val externalStorageVfs: VfsFile

localCurrentDirVfs

val localCurrentDirVfs: VfsFile

Alias for applicationVfs

val nativeCwd: String

val resourcesVfs: VfsFile

resourcesVfsDebug

var resourcesVfsDebug: Boolean

val rootLocalVfs: VfsFile

rootLocalVfsNative

val rootLocalVfsNative: LocalVfsNative

rootLocalVfsNativeSync

val rootLocalVfsNativeSync: LocalVfsNative

actual val standardVfs: StandardVfs

expect val standardVfs: StandardVfs

actual val standardVfs: StandardVfs

actual val standardVfs: StandardVfs

actual val standardVfs: StandardVfs

actual val tempVfs: VfsFile

expect val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

actual val tempVfs: VfsFile

actual val tempVfs: VfsFile

actual val tempVfs: VfsFile

val tmpdir: String

val tmpdir: String

val tmpdir: String

val String.uniVfs: VfsFile

actual val userHomeVfs: VfsFile

expect val userHomeVfs: VfsFile

User home folder, usually ~, /Users/something, /home/something or equivalent

actual val userHomeVfs: VfsFile

actual val userHomeVfs: VfsFile

actual val userHomeVfs: VfsFile

Functions

AndroidDeferredFile

fun AndroidDeferredFile(generate: (Context) -> File): VfsFile

asMemoryVfsFile

fun ByteArray.asMemoryVfsFile(name: String = "temp.bin"): VfsFile

suspend fun VfsFile.cachedToMemory(): VfsFile

createZipFromTree

suspend fun VfsFile.createZipFromTree(): ByteArray

createZipFromTreeTo

suspend fun VfsFile.createZipFromTreeTo(s: AsyncStream)

fun DynamicRootVfs(base: Vfs, rootGet: () -> String): VfsFile

operator fun LocalVfs.Companion.get(base: File): VfsFile

operator fun File.get(path: String): File

operator fun LocalVfs.Companion.get(base: File): VfsFile

suspend fun IsoVfs(file: VfsFile): VfsFile

suspend fun IsoVfs(s: AsyncStream): VfsFile

fun jailedLocalVfs(base: File): VfsFile

fun jailedLocalVfs(base: String): VfsFile

Gets a VfsFile in the Operating System filesystem in base. Jailed. Doesn't support accessing parent folders.

fun jailedLocalVfs(base: File): VfsFile

fun localVfs(base: File): VfsFile

actual fun localVfs(path: String, async: Boolean): VfsFile

expect fun localVfs(path: String, async: Boolean = true): VfsFile

Gets a VfsFile in the Operating System filesystem in path. It supports accessing parent folders.

actual fun localVfs(path: String, async: Boolean): VfsFile

actual fun localVfs(path: String, async: Boolean): VfsFile

fun localVfs(base: File): VfsFile

actual fun localVfs(path: String, async: Boolean): VfsFile

fun VfsFile.log(): VfsFile

fun MemoryVfs(items: Map<String, AsyncStream> = LinkedHashMap(), caseSensitive: Boolean = true): VfsFile

fun MemoryVfsMix(vararg items: Pair<String, Any>, caseSensitive: Boolean = true, charset: Charset = UTF8): VfsFile

fun MemoryVfsMix(items: Map<String, Any> = LinkedHashMap(), caseSensitive: Boolean = true, charset: Charset = UTF8): VfsFile

operator fun UniSchemaProviders.minus(other: UniSchema): UniSchemaProviders

operator fun UniSchemaProviders.minus(other: UniSchemaProviders): UniSchemaProviders

fun Mountable.mount(folder: String, vfs: Vfs): Mountable

inline fun MountableVfs(closeMounts: Boolean = false, callback: Mountable.() -> Unit): VfsFile

MountableVfsSync

inline fun MountableVfsSync(closeMounts: Boolean = false, callback: Mountable.() -> Unit): VfsFile

suspend fun File.open(mode: VfsOpenMode): AsyncStream

suspend fun File.open(mode: VfsOpenMode): AsyncStream

suspend fun VfsFile.openAsIso(): VfsFile

suspend fun AsyncStream.openAsIso(): VfsFile

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

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

suspend fun VfsFile.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true): VfsFile

suspend fun AsyncStream.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true): VfsFile

suspend fun <R> VfsFile.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true, callback: suspend (VfsFile) -> R): R

suspend fun <R> AsyncStream.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true, callback: suspend (VfsFile) -> R): R

operator fun UniSchemaProviders.plus(other: UniSchema): UniSchemaProviders

operator fun UniSchemaProviders.plus(other: UniSchemaProviders): UniSchemaProviders

registerUniSchema

fun registerUniSchema(schema: UniSchema)

registerUniSchemaTemporarily

inline fun <T> registerUniSchemaTemporarily(schema: UniSchema, callback: () -> T): T

SingleFileMemoryVfs

fun SingleFileMemoryVfs(data: ByteArray, ext: String = "bin", basename: String = "file"): VfsFile

fun SingleFileMemoryVfs(data: String, ext: String = "bin", charset: Charset = Charsets.UTF8, basename: String = "file"): VfsFile

SingleFileMemoryVfsWithName

fun SingleFileMemoryVfsWithName(data: ByteArray, name: String): VfsFile

fun SingleFileMemoryVfsWithName(data: String, name: String, charset: Charset = Charsets.UTF8): VfsFile

fun File.toJailedVfs(): VfsFile

fun File.toVfs(): VfsFile

fun SimpleStorage.toVfs(): VfsFile

fun SimpleStorage.toVfs(timeProvider: TimeProvider): VfsFile

fun File.toVfs(): VfsFile

fun ClassLoader.tryGetURLs(): List<URL>

fun String.uniVfs(providers: UniSchemaProviders, base: VfsFile? = null): VfsFile

fun UrlVfs(url: URL): VfsFile

fun UrlVfs(url: URL, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): VfsFile

fun UrlVfs(url: String, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): VfsFile

fun UrlVfs(url: URL): VfsFile

fun UrlVfsJailed(url: URL, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): VfsFile

fun UrlVfsJailed(url: String, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): VfsFile

VfsFileFromData

fun VfsFileFromData(data: ByteArray, ext: String = "bin", basename: String = "file"): VfsFile

fun VfsFileFromData(data: String, ext: String = "bin", charset: Charset = Charsets.UTF8, basename: String = "file"): VfsFile

vfsInitWithAndroidContextOnce

fun vfsInitWithAndroidContextOnce(context: Context)

fun VfsFile.withCatalog(): VfsFile

withCatalogJail

fun VfsFile.withCatalogJail(): VfsFile

suspend fun ByteArray.writeToFile(file: File): Long

suspend fun ZipVfs(s: AsyncStream, vfsFile: VfsFile? = null, caseSensitive: Boolean = true, closeStream: Boolean = false, useNativeDecompression: Boolean = true, fullName: String? = null): VfsFile