ktor-io/io.ktor.utils.io/readAvailable

readAvailable

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

Return

number of bytes were read or -1 if the channel has been closed

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.

Warning: it is not guaranteed that all of available bytes will be represented as a single byte buffer eg: it could be 4 bytes available for read but the provided byte buffer could have only 2 available bytes: in this case you have to invoke read again (with decreased min accordingly).

Return

number of consumed bytes or -1 if the block wasn't executed.

Parameters

min

amount of bytes available for read, should be positive

block

to be invoked when at least min bytes available

suspend fun <Error class: unknown class>.readAvailable(buffer: ByteBuffer): Int

Reads bytes from the channel and writes them to the buffer up to its limit. If the channel's read buffer is exhausted, it suspends until there are bytes available.

Return

the number of bytes read and written to the buffer or -1 if the channel is closed

Parameters

buffer

the buffer to write the read bytes into

fun <Error class: unknown class>.readAvailable(block: (ByteBuffer) -> Int): Int

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

Warning: it is not guaranteed that all of available bytes will be represented as a single byte buffer eg: it could be 4 bytes available for read but the provided byte buffer could have only 2 available bytes: in this case you have to invoke read again (with decreased min accordingly).

Return

number of consumed bytes or -1 if the block wasn't executed.

Parameters

min

amount of bytes available for read, should be positive

block

to be invoked when at least min 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

Return

number of bytes were read or -1 if the channel has been closed

fun Input.readAvailable(cPointer: CPointer<ByteVar>, offset: Int, length: Int): Int