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

IExternalKmpFs

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

Functions

copyFile

open suspend fun copyFile(from: KmpFsRef, to: KmpFsRef): Outcome<Unit, KmpFsError>

Copies a file to another destination.

delete

abstract suspend fun delete(ref: KmpFsRef): Outcome<Unit, KmpFsError>

Deletes a file or directory

exists

abstract suspend fun exists(ref: KmpFsRef): Boolean

Checks if a file or directory exists

list

abstract suspend fun list(dir: KmpFsRef, isRecursive: Boolean = false): Outcome<List<KmpFsRef>, KmpFsError>

Lists the contents of a directory

listWithDepth

open suspend fun listWithDepth(dir: KmpFsRef): Outcome<List<KmpFsRefListItem>, KmpFsError>

Lists a directories files but also includes their relative depth to dir

moveFile

open suspend fun moveFile(from: KmpFsRef, to: KmpFsRef): Outcome<Unit, KmpFsError>

Moves a file to another destination. The destination file must exist and will be overwritten.

nonJsSaveFile

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

pickDirectory

abstract suspend fun pickDirectory(startingDir: KmpFsRef? = null): Outcome<KmpFsRef?, KmpFsError>

Shows a directory picker for a user to select a directory.

pickFile

abstract suspend fun pickFile(startingDir: KmpFsRef? = null, filter: KmpFileFilter? = null): Outcome<KmpFsRef?, KmpFsError>

Shows a file picker for a user to select a single file.

pickFiles

abstract suspend fun pickFiles(startingDir: KmpFsRef? = null, filter: KmpFileFilter? = null): Outcome<List<KmpFsRef>?, KmpFsError>

Shows a file picker for a user to select multiple files.

pickSaveFile

abstract suspend fun pickSaveFile(fileName: String, startingDir: KmpFsRef? = null): Outcome<KmpFsRef?, KmpFsError>

Opens a picker for saving a new file. Android and Desktop allow the user to specify the name. iOS does not have a native save dialog and will instead show a directory picker to save the file. The newly created file ref is returned unless the dialog is cancelled.

readMetadata

abstract suspend fun readMetadata(ref: KmpFsRef): Outcome<KmpFileMetadata, KmpFsError>

Reads metadata of a ref

resolveDirectory

abstract suspend fun resolveDirectory(dir: KmpFsRef, name: String, create: Boolean = false): Outcome<KmpFsRef, KmpFsError>

Opens or creates a directory (if the create option is provided)

resolveDirectoryWithPath

open suspend fun resolveDirectoryWithPath(dir: KmpFsRef, path: String, create: Boolean = false): Outcome<KmpFsRef, KmpFsError>

Resolves a file with a path that is not required to be a direct descendant of dir.

resolveFile

abstract suspend fun resolveFile(dir: KmpFsRef, name: String, create: Boolean = false): Outcome<KmpFsRef, KmpFsError>

Opens or creates a file (if the create option is provided)

resolveFileWithPath

open suspend fun resolveFileWithPath(dir: KmpFsRef, path: String, create: Boolean = false): Outcome<KmpFsRef, KmpFsError>

Resolves a file with a path that is not required to be a direct descendant of dir.

resolveRefFromPath

abstract suspend fun resolveRefFromPath(path: String): Outcome<KmpFsRef, KmpFsError>

Attempts to create a KmpFileRef from the provided path string. This is only supported on the JVM due to sandbox constraints on other platforms.

saveFile

open suspend fun saveFile(source: IKmpIoSource, fileName: String): Outcome<Unit, KmpFsError>

saveFile Save data from a source into a new file

abstract suspend fun saveFile(bytes: ByteArray, fileName: String): Outcome<Unit, KmpFsError>

Saves data into a new file. This will present a file picker on all non-JS platforms. On JS platforms this will show a file picker unless the user has downloads automatically saved to a specific folder.