File

class File

A File stored in a Ouisync repository.

Types

suspend fun close(): Any?

Closes the file.

suspend fun flush(): Any?

Flushes any pending writes to the file.

suspend fun length(): Long

Returns the length of this file in bytes

suspend fun progress(): Long

Returns the sync progress of this file, that is, the total byte size of all the blocks of this file that's already been downloaded.

suspend fun read(offset: Long, length: Long): ByteArray

Reads the given amount of bytes from this file, starting at the given offset.

suspend fun truncate(length: Long): Any?

Truncates the file to the given length.

suspend fun write(offset: Long, array: ByteArray): Any?

Writes the content of the array to the file at the given offset.