Suspend the channel until it has min bytes or gets closed. Throws exception if the channel was closed with an error. If there are bytes available in the channel, this function returns immediately.

cancel

open override fun cancel(cause: Throwable?)

cancel

fun ByteReadChannel.cancel()

copyAndClose

suspend fun ByteReadChannel.copyAndClose(channel: ByteWriteChannel): Long

copyTo

suspend fun ByteReadChannel.copyTo(channel: ByteWriteChannel): Long

suspend fun ByteReadChannel.copyTo(channel: ByteWriteChannel, limit: Long): Long

counted

fun ByteReadChannel.counted(): CountedByteReadChannel

discard

suspend fun ByteReadChannel.discard(max: Long = Long.MAX_VALUE): Long

discardExact

suspend fun ByteReadChannel.discardExact(value: Long)

exhausted

suspend fun ByteReadChannel.exhausted(): Boolean

Suspends the channel until it is exhausted or gets closed. If the read buffer is empty, it suspends until there are bytes available in the channel. Once the channel is exhausted or closed, this function returns.

peek

suspend fun ByteReadChannel.peek(count: Int): ByteString?

Retrieves, but does not consume, up to the specified number of bytes from the current position in this ByteReadChannel.

read

inline suspend fun ByteReadChannel.read(crossinline block: suspend (ByteArray, Int, Int) -> Int): Int

readAvailable

fun ByteReadChannel.readAvailable(min: Int, block: (Buffer) -> Int): Int

Invokes block if it is possible to read at least min byte providing buffer to it so lambda can read from the buffer up to Buffer.readRemaining bytes. If there are no min bytes available then the invocation returns -1.

suspend fun ByteReadChannel.readAvailable(buffer: ByteArray, offset: Int = 0, length: Int = buffer.size - offset): Int

Reads all available bytes to dst buffer and returns immediately or suspends if no bytes available

suspend fun ByteReadChannel.readAvailable(dst: CPointer<ByteVar>, offset: Int, length: Int): Int

Reads all available bytes to dst buffer and returns immediately or suspends if no bytes available

readBuffer

suspend fun ByteReadChannel.readBuffer(): Buffer

suspend fun ByteReadChannel.readBuffer(max: Int): Buffer

readByte

suspend fun ByteReadChannel.readByte(): Byte

readByteArray

suspend fun ByteReadChannel.readByteArray(count: Int): ByteArray

readFully

suspend fun ByteReadChannel.readFully(out: ByteArray, start: Int = 0, end: Int = out.size)

Reads bytes from start to end into the provided out buffer, or fails if the channel has been closed.

readInt

suspend fun ByteReadChannel.readInt(): Int

readLong

suspend fun ByteReadChannel.readLong(): Long

readPacket

suspend fun ByteReadChannel.readPacket(packet: Int): Source

Reads a packet of packet bytes from the channel.

readRemaining

suspend fun ByteReadChannel.readRemaining(): Source

suspend fun ByteReadChannel.readRemaining(max: Long): Source

readShort

suspend fun ByteReadChannel.readShort(): Short

readUntil

suspend fun ByteReadChannel.readUntil(matchString: ByteString, writeChannel: ByteWriteChannel, limit: Long = Long.MAX_VALUE, ignoreMissing: Boolean = false): Long

Reads bytes from the ByteReadChannel until a specified sequence of bytes is encountered or the specified limit is reached.

readUTF8Line

suspend fun ByteReadChannel.readUTF8Line(max: Int = Int.MAX_VALUE): String?

Reads a line of UTF-8 characters from the ByteReadChannel. It recognizes CR, LF and CRLF as line delimiters.

readUTF8LineTo

suspend fun ByteReadChannel.readUTF8LineTo(out: Appendable, max: Int = Int.MAX_VALUE): Boolean

Reads a line of UTF-8 characters to the specified out buffer. It recognizes CR, LF and CRLF as a line delimiter.

rethrowCloseCauseIfNeeded

fun ByteReadChannel.rethrowCloseCauseIfNeeded()

skipIfFound

suspend fun ByteReadChannel.skipIfFound(byteString: ByteString): Boolean

Skips the specified byteString in the ByteReadChannel if it is found at the current position.

toByteArray

suspend fun ByteReadChannel.toByteArray(): ByteArray