Vfs

abstract class Vfs(val context: Context, val logger: Logger, var baseDir: String) : CoroutineScope

A virtual file system that handles loading and streaming data and files.

Author

Colton Daily

Constructors

Vfs

fun Vfs(context: Context, logger: Logger, baseDir: String)

Types

Companion

object Companion

Functions

open fun close()

Cancels this vfs job.

get

operator fun get(path: String): VfsFile

getAbsolutePath

open fun getAbsolutePath(path: String): String

Get the absolute path of the queried path based off the Vfs path.

launch

fun launch(block: suspend Vfs.() -> Unit)

Launches a new coroutine using the this vfs coroutine context. Use this to load assets asynchronously.

load

abstract fun load(key: String): ByteBuffer?

Load an array of bytes from the storage directory based on the key.

loadString

abstract fun loadString(key: String): String?

Load a string from the storage directory based on the key.

readBytes

suspend fun readBytes(assetPath: String): ByteBuffer

Loads a raw file into a ByteBuffer

readStream

suspend fun readStream(assetPath: String): ByteSequenceStream

Opens a stream to a file into a ByteSequenceStream.

store

abstract fun store(key: String, data: ByteArray): Boolean

Store array of bytes in the storage directory based on the key.

abstract fun store(key: String, data: String): Boolean

Store a string in the storage directory based on the key.

Properties

baseDir

var baseDir: String

context

val context: Context

coroutineContext

open override val coroutineContext: CoroutineContext

logger

val logger: Logger

root

val root: VfsFile

The root VfsFile that this Vfs starts from.

Inheritors

AndroidVfs

WebVfs

JvmVfs

Extensions

isOnRenderingThread

expect fun CoroutineScope.isOnRenderingThread(): Boolean

Returns true if the coroutine was launched from the rendering thread dispatcher.

actual fun CoroutineScope.isOnRenderingThread(): Boolean