core/io.nacular.doodle.datatransport/LocalFile

LocalFile

interface LocalFile

Represents a file on the local machine that is being transferred within a DataBundle.

Properties

abstract val isClosed: Boolean

indicates whether the file can be read

abstract val lastModified: Measure<Time>

epoch time of the file

abstract val name: String

of the file

abstract val size: Measure<BinarySize>

of the file

abstract val type: String

mime-type of the file

Functions

abstract suspend fun read(progress: (Float) -> Unit = {}): ByteArray?

Reads the file contents as a ByteArray.

abstract suspend fun readBase64(progress: (Float) -> Unit = {}): String?

Reads the file contents as a base64 encoded String.

abstract suspend fun readText(encoding: String? = null, progress: (Float) -> Unit = {}): String?

Reads the file contents as a String.