Package io.ktor.utils.io.streams

Functions

asInput

fun InputStream.asInput(pool: ObjectPool<ChunkBuffer> = ChunkBuffer.Pool): Input

asOutput

fun OutputStream.asOutput(): Output

fread

~~fun~~ ~~fread~~(~~buffer~~: Buffer, ~~stream~~: <ERROR CLASS><<ERROR CLASS>>): <ERROR CLASS>

fun fread(destination: Memory, offset: Int, length: Int, stream: <ERROR CLASS><<ERROR CLASS>>): Int

fun fread(destination: Memory, offset: Long, length: Long, stream: <ERROR CLASS><<ERROR CLASS>>): Long

fwrite

~~fun~~ ~~fwrite~~(~~buffer~~: Buffer, ~~stream~~: <ERROR CLASS><<ERROR CLASS>>): <ERROR CLASS>

fun fwrite(source: Memory, offset: Int, length: Int, stream: <ERROR CLASS><<ERROR CLASS>>): Int

fun fwrite(source: Memory, offset: Long, length: Long, stream: <ERROR CLASS><<ERROR CLASS>>): Long

Input

fun Input(file: <ERROR CLASS><<ERROR CLASS>>): Input

Create a blocking Input reading from the specified file instance using fread.

fun Input(fileDescriptor: Int): Input

Create a blocking Input reading from the specified fileDescriptor using read.

inputStream

fun ByteReadPacket.inputStream(): InputStream

Creates InputStream adapter to the packet

Output

fun Output(file: <ERROR CLASS><<ERROR CLASS>>): Output

Create a blocking Output writing to the specified file instance using fwrite.

fun Output(fileDescriptor: Int): Output

Create a blocking Output writing to the specified fileDescriptor using write.

outputStream

fun BytePacketBuilder.outputStream(): OutputStream

Creates OutputStream adapter to the builder

read

~~fun~~ ~~read~~(~~fildes~~: Int, ~~buffer~~: Buffer): <ERROR CLASS>

fun read(fildes: Int, destination: Memory, offset: Int, length: Int): Int

fun read(fildes: Int, destination: Memory, offset: Long, length: Long): Long

readerUTF8

fun ByteReadPacket.readerUTF8(): Reader

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

readPacketAtLeast

fun InputStream.readPacketAtLeast(n: Long): ByteReadPacket

Read a packet of at least n bytes or all remaining. Does fail if not enough bytes remaining.

readPacketAtMost

fun InputStream.readPacketAtMost(n: Long): ByteReadPacket

Read a packet of at most n bytes. Resulting packet could be empty however this function always reads as much bytes as possible.

readPacketExact

fun InputStream.readPacketExact(n: Long): ByteReadPacket

Read a packet of exactly n bytes

recv

~~fun~~ ~~recv~~(~~socket~~: <ERROR CLASS>, ~~buffer~~: Buffer, ~~flags~~: Int): <ERROR CLASS>

recvfrom

fun recvfrom(socket: <ERROR CLASS>, buffer: Buffer, flags: Int, addr: <ERROR CLASS><<ERROR CLASS>>, addr_len: <ERROR CLASS><<ERROR CLASS>>): <ERROR CLASS>

send

~~fun~~ ~~send~~(~~socket~~: <ERROR CLASS>, ~~buffer~~: Buffer, ~~flags~~: Int): <ERROR CLASS>

fun send(socket: <ERROR CLASS>, source: Memory, sourceOffset: Int, maxLength: Int, flags: Int): Int

fun send(socket: <ERROR CLASS>, source: Memory, sourceOffset: Long, maxLength: Long, flags: Int): Long

sendto

fun sendto(socket: <ERROR CLASS>, buffer: Buffer, flags: Int, addr: <ERROR CLASS><<ERROR CLASS>>, addr_len: <ERROR CLASS>): <ERROR CLASS>

use

inline fun <R> <ERROR CLASS><<ERROR CLASS>>.use(block: (<ERROR CLASS><<ERROR CLASS>>) -> R): R

write

~~fun~~ ~~write~~(~~fildes~~: Int, ~~buffer~~: Buffer): <ERROR CLASS>

fun write(fildes: Int, source: Memory, offset: Int, length: Int): Int

fun write(fildes: Int, source: Memory, offset: Long, length: Long): Long

writePacket

fun OutputStream.writePacket(packet: ByteReadPacket)

Write the whole packet to the stream

fun OutputStream.writePacket(builder: BytePacketBuilder.() -> Unit)

Write the whole packet to the stream once it is built via builder lambda

writerUTF8

fun BytePacketBuilder.writerUTF8(): Writer

Creates Writer that encodes all characters in UTF-8 encoding