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

IKmpFs

interface IKmpFs

Inheritors

Functions

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

Copies a file to another destination.

Link copied to clipboard
abstract suspend fun delete(ref: KmpFsRef): Outcome<Unit, KmpFsError>

Deletes a file or directory

Link copied to clipboard
abstract suspend fun exists(ref: KmpFsRef): Boolean

Checks if a file or directory exists

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

Lists the contents of a directory

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

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

Link copied to clipboard
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.

Link copied to clipboard
abstract suspend fun readMetadata(ref: KmpFsRef): Outcome<KmpFileMetadata, KmpFsError>

Reads metadata of a ref

Link copied to clipboard
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)

Link copied to clipboard
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.

Link copied to clipboard
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)

Link copied to clipboard
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.