commonMain.kotlinx.io.core.ByteReadPacket.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlinx-io-linuxx64 Show documentation

IO support libraries for Kotlin

There is a newer version: 0.1.16

package kotlinx.io.core

import kotlinx.io.core.internal.*
import kotlinx.io.pool.*

expect class ByteReadPacket internal constructor(head: IoBuffer, remaining: Long, pool: ObjectPool) :
    ByteReadPacketPlatformBase {
    constructor(head: IoBuffer, pool: ObjectPool)

    companion object {
        val Empty: ByteReadPacket

        @Deprecated("This implementation detail is going to become internal.")
        val ReservedSize: Int
    }
}

@DangerousInternalIoApi
expect abstract class ByteReadPacketPlatformBase protected constructor(
    head: IoBuffer,
    remaining: Long,
    pool: ObjectPool
) : ByteReadPacketBase

/**
 * The default abstract base class for implementing [Input] interface.
 * @see [AbstractInput.fill] amd [AbstractInput.closeSource]
 */
@ExperimentalIoApi
abstract class AbstractInput(
    head: IoBuffer = IoBuffer.Empty,
    remaining: Long = head.remainingAll(),
    pool: ObjectPool = IoBuffer.Pool
) : ByteReadPacketPlatformBase(head, remaining, pool) {
    /**
     * Reads the next chunk suitable for reading or `null` if no more chunks available. It is also allowed
     * to return a chain of chunks linked through [IoBuffer.next]. The last chunk should have `null` next reference.
     * Could rethrow exceptions from the underlying source.
     */
    abstract override fun fill(): IoBuffer?

    /**
     * Should close the underlying bytes source. Could do nothing or throw exceptions.
     */
    abstract override fun closeSource()
}

expect fun ByteReadPacket(
    array: ByteArray, offset: Int = 0, length: Int = array.size,
    block: (ByteArray) -> Unit
): ByteReadPacket

@Suppress("NOTHING_TO_INLINE")
inline fun ByteReadPacket(array: ByteArray, offset: Int = 0, length: Int = array.size): ByteReadPacket {
    return ByteReadPacket(array, offset, length) {}
}