Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open class CatalogVfs(val parent: VfsFile) : Vfs.Proxy
Link copied to clipboard
open class DynamicRootVfsVfs(val base: Vfs, val rootGet: () -> String) : Vfs.Proxy
Link copied to clipboard
object EmptyVfs : Vfs
Link copied to clipboard
class FinalUrlVfs(url: String, val dummy: Unit, val client: HttpClient = createHttpClient(), failFromStatus: Boolean = true) : UrlVfs
Link copied to clipboard
object ISO
Link copied to clipboard
class IsoVfs(val iso: ISO.IsoFile, val closeStream: Boolean) : Vfs
Link copied to clipboard
Link copied to clipboard
actual open class LocalVfsNative(async: Boolean) : LocalVfsNativeBase
expect open class LocalVfsNative(async: Boolean = true) : LocalVfsNativeBase
actual open class LocalVfsNative(async: Boolean) : LocalVfsNativeBase
Link copied to clipboard
open class LocalVfsNativeBase(val async: Boolean = true) : LocalVfs
Link copied to clipboard
class LogVfs(val parent: VfsFile) : Vfs.Proxy
Link copied to clipboard
class MapLikeStorageVfs(val storage: SimpleStorage) : Vfs
Link copied to clipboard
open class MergedVfs(vfsList: List<VfsFile> = listOf(), val name: String = "unknown") : Vfs.Proxy
Link copied to clipboard
interface Mountable
Link copied to clipboard
class MountableVfs(val closeMounts: Boolean) : Vfs.Proxy, Mountable
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Contain standard paths to different parts of the operating system.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open class StandardVfs
Link copied to clipboard
class UniSchema(val name: String, val provider: (URL) -> VfsFile)
Link copied to clipboard
class UniSchemaProviders(val providers: Map<String, UniSchema>)
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual val cacheVfs: VfsFile

A Memory Virtual File System for cache

expect val cacheVfs: VfsFile

A Memory Virtual File System for cache

actual val cacheVfs: VfsFile

A Memory Virtual File System for cache

actual val cacheVfs: VfsFile

A Memory Virtual File System for cache

actual val cacheVfs: VfsFile

A Memory Virtual File System for cache

actual val cacheVfs: VfsFile

A Memory Virtual File System for cache

Link copied to clipboard
Link copied to clipboard
val cwd: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

expect val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

actual val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

actual val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

actual val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

actual val tempVfs: VfsFile

Temp folder, usually /tmp or equivalent

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual val userHomeVfs: VfsFile

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

expect val userHomeVfs: VfsFile

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

actual val userHomeVfs: VfsFile

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

actual val userHomeVfs: VfsFile

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

actual val userHomeVfs: VfsFile

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

actual val userHomeVfs: VfsFile

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

Functions

Link copied to clipboard
Link copied to clipboard
suspend fun VfsFile.createZipFromTree(useFolderAsRoot: Boolean = false, compression: CompressionMethod = CompressionMethod.Uncompressed): ByteArray
Link copied to clipboard
suspend fun VfsFile.createZipFromTreeTo(zipFile: VfsFile, compression: CompressionMethod = CompressionMethod.Uncompressed, useFolderAsRoot: Boolean = true): VfsFile
suspend fun VfsFile.createZipFromTreeTo(s: AsyncStream, compression: CompressionMethod = CompressionMethod.Uncompressed, useFolderAsRoot: Boolean = false)
Link copied to clipboard
fun DynamicRootVfs(base: Vfs, rootGet: () -> String): VfsFile
Link copied to clipboard
operator fun LocalVfs.Companion.get(base: File): VfsFile
operator fun LocalVfs.Companion.get(base: String): VfsFile
operator fun File.get(path: String): File
operator fun LocalVfs.Companion.get(base: File): VfsFile
Link copied to clipboard
suspend fun IsoVfs(file: VfsFile): VfsFile
suspend fun IsoVfs(s: AsyncStream): VfsFile
Link copied to clipboard

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

Link copied to clipboard
fun localVfs(base: File): VfsFile

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

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

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

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

fun localVfs(base: File): VfsFile

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

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

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

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

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

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Mountable.mount(folder: String, vfs: Vfs): Mountable
Link copied to clipboard
inline fun MountableVfs(closeMounts: Boolean = false, callback: Mountable.() -> Unit): VfsFile
Link copied to clipboard
inline fun MountableVfsSync(closeMounts: Boolean = false, callback: Mountable.() -> Unit): VfsFile
Link copied to clipboard
suspend fun File.open(mode: VfsOpenMode): AsyncStream
suspend fun File.open(mode: VfsOpenMode): AsyncStream
Link copied to clipboard
suspend fun VfsFile.openAsIso(): VfsFile
suspend fun <R> VfsFile.openAsIso(callback: suspend (VfsFile) -> R): R
suspend fun <R> AsyncStream.openAsIso(callback: suspend (VfsFile) -> R): R
Link copied to clipboard
suspend fun VfsFile.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true, compressionMethods: List<CompressionMethod>? = null): VfsFile
suspend fun AsyncStream.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true, compressionMethods: List<CompressionMethod>? = null): VfsFile
suspend fun <R> AsyncStream.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true, callback: suspend (VfsFile) -> R): R
suspend fun <R> VfsFile.openAsZip(caseSensitive: Boolean = true, useNativeDecompression: Boolean = true, compressionMethods: List<CompressionMethod>? = null, callback: suspend (VfsFile) -> R): R
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> registerUniSchemaTemporarily(schema: UniSchema, callback: () -> T): T
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun String.uniVfs(providers: UniSchemaProviders, base: VfsFile? = null): VfsFile
Link copied to clipboard
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: String, dummy: Unit, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): FinalUrlVfs
fun UrlVfs(url: URL): VfsFile
Link copied to clipboard
fun UrlVfsJailed(url: URL, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): VfsFile
fun UrlVfsJailed(url: String, client: HttpClient = createHttpClient(), failFromStatus: Boolean = true): VfsFile
Link copied to clipboard
inline fun VfsFile.withCatalog(config: (CatalogVfs) -> Unit = {}): VfsFile
Link copied to clipboard
inline fun VfsFile.withCatalogJail(config: (CatalogVfs) -> Unit = {}): VfsFile
Link copied to clipboard
suspend fun ByteArray.writeToFile(file: File): Long
Link copied to clipboard
suspend fun ZipVfs(s: AsyncStream, vfsFile: VfsFile? = null, caseSensitive: Boolean = true, closeStream: Boolean = false, useNativeDecompression: Boolean = true, fullName: String? = null, compressionMethods: List<CompressionMethod>? = null): VfsFile