in ktor-io/common/src/io/ktor/utils/io/ByteReadChannel.kt [54:196]
public suspend fun readFully(dst: ByteArray, offset: Int, length: Int)
public suspend fun readFully(dst: IoBuffer, n: Int)
/**
* Reads the specified amount of bytes and makes a byte packet from them. Fails if channel has been closed
* and not enough bytes available. Accepts [headerSizeHint] to be provided, see [BytePacketBuilder].
*/
public suspend fun readPacket(size: Int, headerSizeHint: Int): ByteReadPacket
/**
* Reads up to [limit] bytes and makes a byte packet or until end of stream encountered.
* Accepts [headerSizeHint] to be provided, see [BytePacketBuilder].
*/
public suspend fun readRemaining(limit: Long, headerSizeHint: Int): ByteReadPacket
/**
* Reads a long number (suspending if not enough bytes available) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readLong(): Long
/**
* Reads an int number (suspending if not enough bytes available) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readInt(): Int
/**
* Reads a short number (suspending if not enough bytes available) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readShort(): Short
/**
* Reads a byte (suspending if no bytes available yet) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readByte(): Byte
/**
* Reads a boolean value (suspending if no bytes available yet) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readBoolean(): Boolean
/**
* Reads double number (suspending if not enough bytes available) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readDouble(): Double
/**
* Reads float number (suspending if not enough bytes available) or fails if channel has been closed
* and not enough bytes.
*/
public suspend fun readFloat(): Float
/**
* Starts non-suspendable read session. After channel preparation [consumer] lambda will be invoked immediately
* event if there are no bytes available for read yet.
*/
@Suppress("DEPRECATION")
@Deprecated("Use read { } instead.")
public fun readSession(consumer: ReadSession.() -> Unit)
/**
* Starts a suspendable read session. After channel preparation [consumer] lambda will be invoked immediately
* even if there are no bytes available for read yet. [consumer] lambda could suspend as much as needed.
*/
@Suppress("DEPRECATION")
@Deprecated("Use read { } instead.")
public suspend fun readSuspendableSession(consumer: suspend SuspendableReadSession.() -> Unit)
/**
* Reads a line of UTF-8 characters to the specified [out] buffer up to [limit] characters.
* Supports both CR-LF and LF line endings. No line ending characters will be appended to [out] buffer.
* Throws an exception if the specified [limit] has been exceeded.
*
* @return `true` if line has been read (possibly empty) or `false` if channel has been closed
* and no characters were read.
*/
public suspend fun <A : Appendable> readUTF8LineTo(out: A, limit: Int): Boolean
/**
* Reads a line of UTF-8 characters up to [limit] characters.
* Supports both CR-LF and LF line endings.
* Throws an exception if the specified [limit] has been exceeded.
*
* @return a line string with no line endings or `null` of channel has been closed
* and no characters were read.
*/
public suspend fun readUTF8Line(limit: Int): String?
/**
* Close channel with optional [cause] cancellation. Unlike [ByteWriteChannel.close] that could close channel
* normally, cancel does always close with error so any operations on this channel will always fail
* and all suspensions will be resumed with exception.
*
* Please note that if the channel has been provided by [reader] or [writer] then the corresponding owning
* coroutine will be cancelled as well
*
* @see ByteWriteChannel.close
*/
public fun cancel(cause: Throwable?): Boolean
/**
* Discard up to [max] bytes
*
* @return number of bytes were discarded
*/
public suspend fun discard(max: Long): Long
/**
* Try to 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 after skipping [offset]
* bytes then it will trigger the underlying source reading first and after that will
* simply copy available bytes even if EOF encountered so [min] is not a requirement but a desired number of bytes.
* It is safe to specify [max] greater than the destination free space.
* `min` shouldn't be bigger than the [destination] free space.
* This function could trigger the underlying source suspending reading.
* It is allowed to specify too big [offset] so in this case this function will always return `0` after prefetching
* all underlying bytes but note that it may lead to significant memory consumption.
* 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 [isClosedForRead].
*
* @param destination to write bytes
* @param offset to skip input
* @param min bytes to be copied, shouldn't be greater than the buffer free space. Could be `0`.
* @param max bytes to be copied even if there are more bytes buffered, could be [Int.MAX_VALUE].
* @return number of bytes copied to the [destination] possibly `0`
*/
public suspend fun peekTo(
destination: Memory,
destinationOffset: Long,
offset: Long = 0,
min: Long = 1,
max: Long = Long.MAX_VALUE
): Long
public companion object {
public val Empty: ByteReadChannel
}