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

IKmpIoSink

interface IKmpIoSink : IKmpIoClosable

Receives a stream of bytes that allows easy writing of multiple data types

All methods have a possibility of throwing exceptions.

Inheritors

OkIoKmpIoSink

Functions

abstract suspend override fun close()

Closes the sink. No further operation should be executed after the sink is closed.

flush

abstract suspend fun flush()

Flushes all written bytes to the destination

write

abstract suspend fun write(source: ByteArray, sourceOffset: Int = 0, byteCount: Int = source.size): IKmpIoSink

Writes byteCount bytes starting at sourceOffset from the source into the sink

writeAll

open suspend fun writeAll(source: IKmpIoSource, bufferSize: Int = 16384): Long

Writes all bytes from the source to the sink

writeByte

open suspend fun writeByte(value: Byte): IKmpIoSink

Writes a single byte to the sink

writeDouble

open suspend fun writeDouble(value: Double): IKmpIoSink

Writes a double to the sink

writeDoubleLe

open suspend fun writeDoubleLe(value: Double): IKmpIoSink

Writes a double in little-endian order to the sink

writeFloat

open suspend fun writeFloat(value: Float): IKmpIoSink

Writes a float to the sink

writeFloatLe

open suspend fun writeFloatLe(value: Float): IKmpIoSink

Writes a float in little-endian order to the sink

writeInt

open suspend fun writeInt(value: Int): IKmpIoSink

Writes an int to the sink

writeIntLe

open suspend fun writeIntLe(value: Int): IKmpIoSink

Writes an int in little-endian order to the sink

writeLong

open suspend fun writeLong(value: Long): IKmpIoSink

Writes a long to the sink

writeLongLe

open suspend fun writeLongLe(value: Long): IKmpIoSink

Writes a long in little-endian order to the sink

writeShort

open suspend fun writeShort(value: Short): IKmpIoSink

Writes a short to the sink

writeShortLe

open suspend fun writeShortLe(value: Short): IKmpIoSink

Writes a short in little-endian order to the sink

writeUtf8

open suspend fun writeUtf8(value: String): IKmpIoSink

Writes a UTF-8 encoded string to the sink