Package io.ktor.utils.io.core
Types
The default abstract base class implementing Input interface.
The default Output implementation.
A builder that provides ability to build byte packets with no knowledge of it's size. Unlike Java's ByteArrayOutputStream it doesn't copy the whole content every time it's internal buffer overflows but chunks buffers instead. Packet building via build function is O(1) operation and only does instantiate a new ByteReadPacket. Once a byte packet has been built via build function call, the builder could be reused again. You also can discard all written bytes via reset or release. Please note that an instance of builder need to be terminated either via build function invocation or via release call otherwise it will cause byte buffer leak so that may have performance impact.
API marked with this annotation is experimental and could be changed
Usually shouldn't be implemented directly. Inherit AbstractInput instead.
Shouldn't be implemented directly. Inherit AbstractInput instead.
A read-write facade to actual buffer of fixed size. Multiple views could share the same actual buffer. Concurrent unsafe. The only concurrent-safe operation is release. In most cases ByteReadPacket and BytePacketBuilder should be used instead.
A read-write facade to actual buffer of fixed size. Multiple views could share the same actual buffer.
This shouldn't be implemented directly. Inherit AbstractOutput instead.
This shouldn't be implemented directly. Inherit AbstractOutput instead.
Functions
Build a byte packet in block lambda. Creates a temporary builder and releases it in case of failure
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.
Discard exactly n bytes or fail if not enough bytes in the input to be discarded.
Discards bytes until delimiter occurred
Discards bytes until of of the specified delimiters delimiter1 or delimiter2 occurred
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.
Creates a temporary packet view of the packet being build without discarding any bytes from the builder. This is similar to build().copy() except that the builder keeps already written bytes untouched. A temporary view packet is passed as argument to block function and it shouldn't leak outside of this block otherwise an unexpected behaviour may occur.
Read available for read bytes to the destination array range starting at array offset and length bytes. If less than length bytes available then less bytes will be copied and the corresponding number will be returned as result.
Read available for read bytes to the destination array range starting at array offset and length elements. If less than length elements available then less elements will be copied and the corresponding number will be returned as result (possibly zero).
Read at most dst.remaining() bytes to the specified dst byte buffer and change its position accordingly
Read exactly n (optional, read all remaining by default) bytes to a newly allocated byte buffer
Reads all remaining bytes from the input
Read the specified number of bytes specified (optional, read all remaining by default)
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.
Reads exactly n bytes from the input or fails if not enough bytes available.
Read a floating point number or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Read a floating point number or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Read from this buffer to the destination array to offset and length bytes.
Read from this buffer to the destination array to offset and length bytes. Numeric values are interpreted in the network byte order (Big Endian).
Read buffer's content to the destination buffer moving its position.
Read exactly dst.remaining() bytes to the specified dst byte buffer and change its position accordingly
Read an integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Read a long integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Read a short integer or fail if no bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Reads at most max characters decoding bytes with specified charset. Extra character bytes will remain unconsumed
Reads at most max characters decoding bytes with specified decoder. Extra character bytes will remain unconsumed
Read exactly the specified number of bytes interpreting bytes in the specified charset (optional, UTF-8 by default).
Read exactly bytesCount interpreting bytes in the specified charset (optional, UTF-8 by default).
Read exactly charactersCount characters interpreting bytes in the specified charset.
Read an unsigned integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Read an unsigned long integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Copies to dst output until one of the specified delimiters delimiter1 or delimiter2 occurred.
Copies to dst array at offset at most length bytes or until one of the specified delimiters delimiter1 or delimiter2 occurred.
Read an unsigned short integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).
Reads UTF-8 line and append all line characters to out except line endings. Supports CR, LF and CR+LF
Reads UTF-8 characters until one of the specified delimiters found, limit exceeded or end of stream encountered
Reads UTF-8 characters to out buffer until one of the specified delimiters found, limit exceeded or end of stream encountered
Summarize remainings of all elements of the chain
Discard all written bytes and prepare to build another packet.
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
Write bytes directly to packet builder's segment. Generally shouldn't be used in user's code and useful for efficient integration.
Write bytes directly to packet builder's segment. Generally shouldn't be used in user's code and useful for efficient integration.
Write a floating point number or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write a floating point number or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write all readable bytes from src to this buffer. Fails if not enough space available to write all bytes.
Write at most length readable bytes from src to this buffer. Fails if not enough space available to write all bytes.
Write source buffer content moving its position.
Write all src buffer remaining bytes and change it's position accordingly
Write all remaining src buffer bytes and change its position accordingly
Write an integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write a long integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write a short integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write an unsigned byte or fail if not enough space available for writing.
Write an unsigned integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write an unsigned long integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Write an unsigned short integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).
Append number of chunks invoking block function while the returned value is positive. If returned value is positive then it will be invoked again with a buffer having at least requested number of bytes space (could be the same buffer as before if it complies to the restriction).
Properties
For streaming input it should be Input.endOfInput instead.
For streaming input there is no reliable way to detect it without triggering bytes population from the underlying source. Consider using Input.endOfInput or use ByteReadPacket instead.