oskit-kmp/com.outsidesource.oskitkmp.filesystem/KmpFsRef

KmpFsRef

@Serializable

Represents a lightweight reference to a file/directory location. Refs do not contain any file data or file handles themselves, only a reference to a location. Refs also contain basic information like file/directory name and if it is a file or directory.

Types

Companion

object Companion

Properties

fsType

@SerialName(value = "4")

val fsType: KmpFsType

isDirectory

@SerialName(value = "3")

val isDirectory: Boolean

name

@SerialName(value = "2")

val name: String

Functions

clearPersistedDataCache

suspend fun clearPersistedDataCache()

Clears any cached data for a given ref. The WASM target requires caching ref data in a specific way to persist references. This will clear any cache data and render the persisted ref useless after the current session.

sink

actual suspend fun KmpFsRef.sink(mode: KmpFsWriteMode): Outcome<IKmpIoSink, KmpFsError>

expect suspend fun KmpFsRef.sink(mode: KmpFsWriteMode = KmpFsWriteMode.Overwrite): Outcome<IKmpIoSink, KmpFsError>

Creates a writable sink for the ref

actual suspend fun KmpFsRef.sink(mode: KmpFsWriteMode): Outcome<IKmpIoSink, KmpFsError>

source

actual suspend fun KmpFsRef.source(): Outcome<IKmpIoSource, KmpFsError>

expect suspend fun KmpFsRef.source(): Outcome<IKmpIoSource, KmpFsError>

Creates a readable source for the ref

actual suspend fun KmpFsRef.source(): Outcome<IKmpIoSource, KmpFsError>

toPersistableBytes

suspend fun toPersistableBytes(): ByteArray

Creates a byteArray that is safe for persisting to a key/value store or a database for future use with KmpFsRef.fromPersistableBytes

toPersistableString

suspend fun toPersistableString(): String

Creates a string that is safe for persisting to a key/value store or a database for future use with KmpFsRef.fromPersistableString