5.0.0

oskit-kmp/com.outsidesource.oskitkmp.filesystem

Package-level declarations

Types

FileSystemHandleKind

enum FileSystemHandleKind : Enum<FileSystemHandleKind>

object FsUtil

interface IExternalKmpFs : IKmpFs

The External API interface for interacting with non-sandboxed files/directories. A ref must be picked for a starting point.

interface IInternalKmpFs : IKmpFs

The Internal API interface for interacting with sandboxed files/directories

interface IKmpFs

typealias KmpFileFilter = List<KmpFileMimetype>

KmpFileMetadata

data class KmpFileMetadata(val size: Long)

KmpFileMetadata defines metadata for files. Only size is supported for now.

KmpFileMimetype

data class KmpFileMimetype(val extension: String, val mimeType: String)

Defines a common MimeType interface

object KmpFs

KmpFs Provides limited multiplatform (iOS, Android, Desktop, and Web Browser) filesystem interactions both inside and outside application sandboxes in iOS and Android via a mostly unified API. KmpFs is split into two primary APIs: IInternalKmpFs and IExternalKmpFs which both implement IKmpFs.

actual data class KmpFsContext

expect class KmpFsContext

actual data class KmpFsContext

actual class KmpFsContext

actual class KmpFsContext

sealed class KmpFsError : Throwable

@Serializable

data class KmpFsRef

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.

KmpFsRefListItem

data class KmpFsRefListItem(val depth: Int, val ref: KmpFsRef)

Returned from IKmpFs.listWithDepth

enum KmpFsType : Enum<KmpFsType>

The KmpFs API being used

enum KmpFsWriteMode : Enum<KmpFsWriteMode>

The write mode for a sink

Functions

internalClearPersistedDataCache

actual suspend fun internalClearPersistedDataCache(ref: KmpFsRef?)

suspend fun IExternalKmpFs.nonJsSaveFile(bytes: ByteArray, fileName: String): Outcome<Unit, KmpFsError>

onKmpFileRefPersisted

actual suspend fun onKmpFileRefPersisted(ref: KmpFsRef)

platformExternalKmpFs

actual fun platformExternalKmpFs(): IExternalKmpFs

actual fun platformExternalKmpFs(): IExternalKmpFs

actual fun platformExternalKmpFs(): IExternalKmpFs

actual fun platformExternalKmpFs(): IExternalKmpFs

platformInternalKmpFs

actual fun platformInternalKmpFs(): IInternalKmpFs

actual fun platformInternalKmpFs(): IInternalKmpFs

actual fun platformInternalKmpFs(): IInternalKmpFs

actual fun platformInternalKmpFs(): IInternalKmpFs

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>

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

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

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>

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

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