core/com.lehaine.littlekt.file/JvmVfs

JvmVfs

class JvmVfs(val context: Context, val logger: Logger, storageBaseDir: String, assetsBaseDir: String) : Vfs

Author

Colton Daily

Constructors

JvmVfs

fun JvmVfs(context: Context, logger: Logger, storageBaseDir: String, assetsBaseDir: String)

Types

Companion

object Companion

KeyValueEntry

@Serializable

data class KeyValueEntry(val k: String, val v: String)

KeyValueStore

@Serializable

data class KeyValueStore(val keyValues: List<JvmVfs.KeyValueEntry>)

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

open override fun load(key: String): ByteBuffer?

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

loadString

open override 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

open override fun store(key: String, data: ByteArray): Boolean

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

open override 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.

Extensions

isOnRenderingThread

expect fun CoroutineScope.isOnRenderingThread(): Boolean

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

actual fun CoroutineScope.isOnRenderingThread(): Boolean