oskit-kmp/com.outsidesource.oskitkmp.io/IKmpIoSource

IKmpIoSource

interface IKmpIoSource : IKmpIoClosable

Supplies a stream of bytes that allows easy reading of multiple data types

All methods have a possibility of throwing exceptions.

Inheritors

OkIoKmpIoSource

Functions

abstract suspend override fun close()

Closes the source. Any further operation will return an error.

isExhausted

abstract suspend fun isExhausted(): Boolean

Returns true if the source has no more bytes

read

abstract suspend fun read(buffer: ByteArray, bufferOffset: Int = 0, byteCount: Int = buffer.size): Int

Reads bytes into the provided buffer

readAll

abstract suspend fun readAll(): ByteArray

Reads all remaining bytes in the source and returns them as a ByteArray

open suspend fun readAll(sink: IKmpIoSink, buffer: ByteArray = ByteArray(16384)): Long

Reads all remaining bytes from the source into provided sink

readAllUtf8

open suspend fun readAllUtf8(): String

Reads all remaining bytes from the source and returns them as a UTF-8 encoded string

readByte

open suspend fun readByte(buffer: ByteArray = ByteArray(1)): Byte

Reads a single byte from the source

readDouble

open suspend fun readDouble(buffer: ByteArray = ByteArray(8)): Double

Reads a double from the source

readDoubleLe

open suspend fun readDoubleLe(buffer: ByteArray = ByteArray(8)): Double

Reads a double in little-endian order from the source

readFloat

open suspend fun readFloat(buffer: ByteArray = ByteArray(4)): Float

Reads a float from the source

readFloatLe

open suspend fun readFloatLe(buffer: ByteArray = ByteArray(4)): Float

Reads a float in little-endian order from the source

readInt

open suspend fun readInt(buffer: ByteArray = ByteArray(4)): Int

Reads an int from the source

readIntLe

open suspend fun readIntLe(buffer: ByteArray = ByteArray(4)): Int

Reads an int in little-endian order from the source

readLong

open suspend fun readLong(buffer: ByteArray = ByteArray(8)): Long

Reads a long from the source

readLongLe

open suspend fun readLongLe(buffer: ByteArray = ByteArray(8)): Long

Reads a long in little-endian order from the source

readShort

open suspend fun readShort(buffer: ByteArray = ByteArray(2)): Short

Reads a short from the source

readShortLe

open suspend fun readShortLe(buffer: ByteArray = ByteArray(2)): Short

Reads a short in little-endian order from the source

readUtf8

open suspend fun readUtf8(byteCount: Int, buffer: ByteArray = ByteArray(byteCount)): String

Reads a UTF-8 encoded string from the source

readUtf8Line

abstract suspend fun readUtf8Line(buffer: ByteArray = ByteArray(1024)): String?

Reads a single Utf8 encoded line from the source

require

abstract suspend fun require(byteCount: Long)

Returns when the buffer contains at least byteCount bytes. Throws a KmpIoError.Eof if the source is exhausted before the required bytes can be read.