ByteReadPacket

class ByteReadPacket : ByteReadPacketPlatformBase, Input

Read-only immutable byte packet. Could be consumed only once however it does support copy that doesn’t copy every byte but creates a new view instead. Once packet created it should be either completely read (consumed) or released via release.

Constructors

<init>

ByteReadPacket(
    head: ChunkBuffer,
    pool: ObjectPool<ChunkBuffer>)
ByteReadPacket(head: IoBuffer, pool: ObjectPool<ChunkBuffer>)

Functions

closeSource

fun closeSource(): Unit

Should close the underlying bytes source. Could do nothing or throw exceptions.

copy

fun copy(): ByteReadPacket

Returns a copy of the packet. The original packet and the copy could be used concurrently. Both need to be either completely consumed or released via release

fill

fun fill(): Nothing?

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 ChunkBuffer.next. The last chunk should have null next reference. Could rethrow exceptions from the underlying source.

fun fill(destination: Memory, offset: Int, length: Int): Int

Read the next bytes into the destination starting at offset at most length bytes. May block until at least one byte is available. Usually bypass all exceptions from the underlying source.

toString

fun toString(): String

Companion Object Properties

Empty

val Empty: ByteReadPacket

ReservedSize

val ReservedSize: Int

Extension Properties

isEmpty

val ByteReadPacket.isEmpty: Boolean

isNotEmpty

val ByteReadPacket.isNotEmpty: Boolean

Extension Functions

$unsafeAppend$

fun ByteReadPacket.$unsafeAppend$(
    builder: BytePacketBuilder
): Unit

asStream

fun Input.asStream(): InputStream

Convert io.ktor.utils.io Input to java InputStream

completeReadHead

fun Input.completeReadHead(current: IoBuffer): Unit
fun Input.completeReadHead(current: ChunkBuffer): Unit

copyTo

fun Input.copyTo(output: Output): Long

Copy all bytes to the output. Depending on actual input and output implementation it could be zero-copy or copy byte per byte. All regular types such as ByteReadPacket, BytePacketBuilder, AbstractInput and AbstractOutput are always optimized so no bytes will be copied.

decodeBase64

fun ByteReadPacket.decodeBase64(): String

decodeBase64Bytes

fun ByteReadPacket.decodeBase64Bytes(): Input

Decode ByteReadPacket from base64 format

discard

fun Input.discard(): Long

Discard all remaining bytes.

discardExact

fun Input.discardExact(n: Long): Unit
fun Input.discardExact(n: Int): Unit

Discard exactly n bytes or fail if not enough bytes in the input to be discarded.

discardUntilDelimiter

fun Input.discardUntilDelimiter(delimiter: Byte): Long

Discards bytes until delimiter occurred

discardUntilDelimiters

fun Input.discardUntilDelimiters(
    delimiter1: Byte,
    delimiter2: Byte
): Long

Discards bytes until of of the specified delimiters delimiter1 or delimiter2 occurred

encodeBase64

fun ByteReadPacket.encodeBase64(): String

Encode ByteReadPacket in base64 format

inputStream

fun ByteReadPacket.inputStream(): InputStream

Creates InputStream adapter to the packet

peekCharUtf8

fun Input.peekCharUtf8(): Char

peekTo

fun Input.peekTo(
    destination: IoBuffer,
    offset: Int = 0,
    min: Int = 1,
    max: Int = Int.MAX_VALUE
): Int
fun Input.peekTo(
    destination: Buffer,
    offset: Int = 0,
    min: Int = 1,
    max: Int = Int.MAX_VALUE
): Int

Copy at least min but up to max bytes to the specified destination buffer from this input skipping offset bytes. If there are not enough bytes available to provide min bytes then it simply return number of available bytes with no exception so the returned value need to be checked. It is safe to specify max > destination.writeRemaining but min shouldn’t be bigger than the destination free space. This function could trigger the underlying source reading that may lead to blocking I/O. It is safe to specify too big offset so in this case this function will always return 0. This function usually copy more bytes than min (unless max = min) but it is not guaranteed. When 0 is returned with offset = 0 then it makes sense to check Input.endOfInput.

prepareReadFirstHead

fun Input.prepareReadFirstHead(minSize: Int): ChunkBuffer?

prepareReadFirstHeadOld

fun Input.prepareReadFirstHeadOld(minSize: Int): IoBuffer?

prepareReadNextHead

fun Input.prepareReadNextHead(
    current: ChunkBuffer
): ChunkBuffer?

prepareReadNextHeadOld

fun Input.prepareReadNextHeadOld(
    current: IoBuffer
): IoBuffer?

readAvailable

fun ByteReadPacket.readAvailable(dst: ByteBuffer): Int

Read at most dst.remaining() bytes to the specified dst byte buffer and change it’s position accordingly

fun Input.readAvailable(
    dst: IoBuffer,
    size: Int = dst.writeRemaining
): Int
fun Input.readAvailable(
    dst: ByteArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailable(
    dst: ShortArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailable(
    dst: IntArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailable(
    dst: LongArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailable(
    dst: FloatArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailable(
    dst: DoubleArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailable(
    dst: Buffer,
    length: Int = dst.writeRemaining
): Int
fun Input.readAvailable(
    destination: Memory,
    destinationOffset: Int,
    length: Int
): Int
fun Input.readAvailable(
    destination: Memory,
    destinationOffset: Long,
    length: Long
): Long
fun Input.readAvailable(
    dst: ByteBuffer,
    length: Int = dst.remaining()
): Int

readAvailableLittleEndian

fun Input.readAvailableLittleEndian(
    dst: <ERROR CLASS>,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableLittleEndian(
    dst: ShortArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableLittleEndian(
    dst: IntArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableLittleEndian(
    dst: LongArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableLittleEndian(
    dst: FloatArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableLittleEndian(
    dst: DoubleArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int

readAvailableOld

fun Input.readAvailableOld(
    dst: ByteArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableOld(
    dst: ShortArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableOld(
    dst: IntArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableOld(
    dst: LongArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableOld(
    dst: FloatArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int
fun Input.readAvailableOld(
    dst: DoubleArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Int

readByteBuffer

fun ByteReadPacket.readByteBuffer(
    n: Int = remaining.coerceAtMostMaxIntOrFail("Unable to make a ByteBuffer: packet is too big"),
    direct: Boolean = false
): ByteBuffer

Read exactly n (optional, read all remaining by default) bytes to a newly allocated byte buffer

readBytes

fun ByteReadPacket.readBytes(
    n: Int = remaining.coerceAtMostMaxIntOrFail("Unable to convert to a ByteArray: packet is too big")
): ByteArray

Read exactly n bytes (consumes all remaining if n is not specified but up to Int.MAX_VALUE bytes). Does fail if not enough bytes remaining.

fun Input.readBytes(): ByteArray

Reads all remaining bytes from the input

readBytesOf

fun Input.readBytesOf(
    min: Int = 0,
    max: Int = Int.MAX_VALUE
): ByteArray

Reads at least min but no more than max bytes from the input to a new byte array

readDirect

fun ByteReadPacket.readDirect(
    size: Int,
    block: (ByteBuffer) -> Unit
): Unit

readDouble

fun Input.readDouble(byteOrder: ByteOrder): Double
fun Input.readDouble(): Double

readDoubleFallback

fun Input.readDoubleFallback(): Double

readDoubleLittleEndian

fun Input.readDoubleLittleEndian(): Double

readFloat

fun Input.readFloat(byteOrder: ByteOrder): Float
fun Input.readFloat(): Float

readFloatFallback

fun Input.readFloatFallback(): Float

readFloatLittleEndian

fun Input.readFloatLittleEndian(): Float

readFully

fun ByteReadPacket.readFully(dst: ByteBuffer): Int

Read exactly dst.remaining() bytes to the specified dst byte buffer and change it’s position accordingly

fun Input.readFully(
    dst: IoBuffer,
    size: Int = dst.writeRemaining
): Unit
fun Input.readFully(
    dst: ByteArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: ShortArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: IntArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: LongArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: FloatArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: DoubleArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: Buffer,
    length: Int = dst.writeRemaining
): Unit
fun Input.readFully(
    destination: Memory,
    destinationOffset: Int,
    length: Int
): Unit
fun Input.readFully(
    destination: Memory,
    destinationOffset: Long,
    length: Long
): Unit
fun Input.readFully(
    dst: <ERROR CLASS>,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFully(
    dst: ByteBuffer,
    length: Int = dst.remaining()
): Unit

readFullyLittleEndian

fun Input.readFullyLittleEndian(
    dst: <ERROR CLASS>,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyLittleEndian(
    dst: ShortArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyLittleEndian(
    dst: IntArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyLittleEndian(
    dst: LongArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyLittleEndian(
    dst: FloatArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyLittleEndian(
    dst: DoubleArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit

readFullyOld

fun Input.readFullyOld(
    dst: ByteArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyOld(
    dst: ShortArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyOld(
    dst: IntArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyOld(
    dst: LongArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyOld(
    dst: FloatArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit
fun Input.readFullyOld(
    dst: DoubleArray,
    offset: Int = 0,
    length: Int = dst.size - offset
): Unit

readInt

fun Input.readInt(byteOrder: ByteOrder): Int
fun Input.readInt(): Int

readIntLittleEndian

fun Input.readIntLittleEndian(): Int

readLong

fun Input.readLong(byteOrder: ByteOrder): Long
fun Input.readLong(): Long

readLongLittleEndian

fun Input.readLongLittleEndian(): Long

readShort

fun Input.readShort(byteOrder: ByteOrder): Short
fun Input.readShort(): Short

readShortLittleEndian

fun Input.readShortLittleEndian(): Short

readText

fun ByteReadPacket.readText(
    decoder: CharsetDecoder,
    out: Appendable,
    max: Int = Int.MAX_VALUE
): Int
fun Input.readText(
    out: Appendable,
    decoder: CharsetDecoder,
    max: Int = Int.MAX_VALUE
): Int
fun Input.readText(
    decoder: CharsetDecoder,
    max: Int = Int.MAX_VALUE
): String

Reads at most max characters decoding bytes with specified decoder. Extra character bytes will remain unconsumed

fun Input.readText(
    out: Appendable,
    charset: Charset = Charsets.UTF_8,
    max: Int = Int.MAX_VALUE
): Int
fun Input.readText(
    charset: Charset = Charsets.UTF_8,
    max: Int = Int.MAX_VALUE
): String

Reads at most max characters decoding bytes with specified charset. Extra character bytes will remain unconsumed

readTextExact

fun Input.readTextExact(
    charset: Charset = Charsets.UTF_8,
    n: Int
): String

Read exactly n characters interpreting bytes in the specified charset.

readTextExactBytes

fun Input.readTextExactBytes(
    charset: Charset = Charsets.UTF_8,
    bytes: Int
): String

Read exactly the specified number of bytes interpreting bytes in the specified charset (optional, UTF-8 by default).

fun Input.readTextExactBytes(
    bytesCount: Int,
    charset: Charset = Charsets.UTF_8
): String

Read exactly bytesCount interpreting bytes in the specified charset (optional, UTF-8 by default).

readTextExactCharacters

fun Input.readTextExactCharacters(
    charactersCount: Int,
    charset: Charset = Charsets.UTF_8
): String

Read exactly charactersCount characters interpreting bytes in the specified charset.

readUByte

fun Input.readUByte(): <ERROR CLASS>

readUInt

fun Input.readUInt(): <ERROR CLASS>

readULong

fun Input.readULong(): <ERROR CLASS>

readUShort

fun Input.readUShort(): <ERROR CLASS>

readUTF8Line

fun ByteReadPacket.readUTF8Line(
    estimate: Int = 16,
    limit: Int = Int.MAX_VALUE
): String?

Read a string line considering optionally specified estimate but up to optional limit characters length (does fail once limit exceeded) or return null if the packet is empty

readUTF8LineTo

fun Input.readUTF8LineTo(
    out: Appendable,
    limit: Int
): Boolean

Read UTF-8 line and append all line characters to out except line endings. Does support CR, LF and CR+LF

readUTF8UntilDelimiter

fun Input.readUTF8UntilDelimiter(
    delimiters: String,
    limit: Int = Int.MAX_VALUE
): String

Reads UTF-8 characters until one of the specified delimiters found, limit exceeded or end of stream encountered

readUTF8UntilDelimiterTo

fun Input.readUTF8UntilDelimiterTo(
    out: Appendable,
    delimiters: String,
    limit: Int = Int.MAX_VALUE
): Int
fun Input.readUTF8UntilDelimiterTo(
    out: Output,
    delimiters: String,
    limit: Int = Int.MAX_VALUE
): Int

Reads UTF-8 characters to out buffer until one of the specified delimiters found, limit exceeded or end of stream encountered

fun Input.readUTF8UntilDelimiterTo(
    out: BytePacketBuilderBase,
    delimiters: String,
    limit: Int = Int.MAX_VALUE
): Int

readUntilDelimiter

fun Input.readUntilDelimiter(
    delimiter: Byte,
    dst: ByteArray,
    offset: Int = 0,
    length: Int = dst.size
): Int

Copies to dst array at offset at most length bytes or until the specified delimiter occurred.

fun Input.readUntilDelimiter(
    delimiter: Byte,
    dst: Output
): Long

Copies to dst output until the specified delimiter occurred.

readUntilDelimiters

fun Input.readUntilDelimiters(
    delimiter1: Byte,
    delimiter2: Byte,
    dst: ByteArray,
    offset: Int = 0,
    length: Int = dst.size
): Int

Copies to dst array at offset at most length bytes or until one of the specified delimiters delimiter1 or delimiter2 occurred.

fun Input.readUntilDelimiters(
    delimiter1: Byte,
    delimiter2: Byte,
    dst: Output
): Long

Copies to dst output until one of the specified delimiters delimiter1 or delimiter2 occurred.

readerUTF8

fun ByteReadPacket.readerUTF8(): Reader

Creates Reader from the byte packet that decodes UTF-8 characters

takeWhile

fun Input.takeWhile(block: (Buffer) -> Boolean): Unit

Invoke block function for every chunk until end of input or block function return false block function returns true to request more chunks or false to stop loop

takeWhileSize

fun Input.takeWhileSize(
    initialSize: Int = 1,
    block: (Buffer) -> Int
): Unit

Invoke block function for every chunk until end of input or block function return zero block function returns number of bytes required to read next primitive and shouldn’t require too many bytes at once otherwise it could fail with an exception. It is not guaranteed that every chunk will have fixed size but it will be always at least requested bytes length. block function should never release provided buffer and should not write to it otherwise an undefined behaviour could be observed