BufferedSource

interface BufferedSource : Source

A source that keeps a buffer internally so that callers can do small reads without a performance penalty. It also allows clients to read ahead, buffering as much as necessary before consuming input.

interface BufferedSource : Source, ReadableByteChannel

Functions

common

abstract override fun close()

Closes this source and releases the resources held by this source.

jvm

abstract override fun close()

Closes this source and releases the resources held by this source.

equals

open operator fun equals(other: Any?): Boolean

exhausted

common

abstract fun exhausted(): Boolean

Returns true if there are no more bytes in this source.

jvm

abstract fun exhausted(): Boolean

hashCode

open fun hashCode(): Int

indexOf

common

abstract fun indexOf(b: Byte): Long

Equivalent to indexOf(b, 0).

jvm

abstract fun indexOf(b: Byte): Long

common

abstract fun indexOf(bytes: ByteString): Long

Equivalent to indexOf(bytes, 0).

jvm

abstract fun indexOf(bytes: ByteString): Long

common

abstract fun indexOf(b: Byte, fromIndex: Long): Long

Returns the index of the first b in the buffer at or after fromIndex.

jvm

abstract fun indexOf(b: Byte, fromIndex: Long): Long

common

abstract fun indexOf(bytes: ByteString, fromIndex: Long): Long

Returns the index of the first match for bytes in the buffer at or after fromIndex.

jvm

abstract fun indexOf(bytes: ByteString, fromIndex: Long): Long

common

abstract fun indexOf(b: Byte, fromIndex: Long, toIndex: Long): Long

Returns the index of b if it is found in the range of fromIndex inclusive to toIndex exclusive.

jvm

abstract fun indexOf(b: Byte, fromIndex: Long, toIndex: Long): Long

indexOfElement

common

abstract fun indexOfElement(targetBytes: ByteString): Long

Equivalent to indexOfElement(targetBytes, 0).

jvm

abstract fun indexOfElement(targetBytes: ByteString): Long

common

abstract fun indexOfElement(targetBytes: ByteString, fromIndex: Long): Long

Returns the first index in this buffer that is at or after fromIndex and that contains any of the bytes in targetBytes.

jvm

abstract fun indexOfElement(targetBytes: ByteString, fromIndex: Long): Long

inputStream

jvm

abstract fun inputStream(): InputStream

Returns an input stream that reads from this source.

isOpen

jvm

abstract fun isOpen(): Boolean

peek

common

abstract fun peek(): BufferedSource

Returns a new BufferedSource that can read data from this BufferedSource without consuming it.

jvm

abstract fun peek(): BufferedSource

rangeEquals

common

abstract fun rangeEquals(offset: Long, bytes: ByteString): Boolean

Returns true if the bytes at offset in this source equal bytes.

jvm

abstract fun rangeEquals(offset: Long, bytes: ByteString): Boolean

common

abstract fun rangeEquals(offset: Long, bytes: ByteString, bytesOffset: Int, byteCount: Int): Boolean

Returns true if byteCount bytes at offset in this source equal bytes at bytesOffset.

jvm

abstract fun rangeEquals(offset: Long, bytes: ByteString, bytesOffset: Int, byteCount: Int): Boolean

read

jvm

abstract fun read(p0: ByteBuffer): Int

common

abstract fun read(sink: ByteArray): Int

Removes up to sink.length bytes from this and copies them into sink.

jvm

abstract fun read(sink: ByteArray): Int

common

abstract fun read(sink: Buffer, byteCount: Long): Long

Removes at least 1, and up to byteCount bytes from this and appends them to sink.

jvm

abstract fun read(sink: Buffer, byteCount: Long): Long

Removes at least 1, and up to byteCount bytes from this and appends them to sink.

common

abstract fun read(sink: ByteArray, offset: Int, byteCount: Int): Int

Removes up to byteCount bytes from this and copies them into sink at offset.

jvm

abstract fun read(sink: ByteArray, offset: Int, byteCount: Int): Int

readAll

common

abstract fun readAll(sink: Sink): Long

Removes all bytes from this and appends them to sink.

jvm

abstract fun readAll(sink: Sink): Long

readByte

common

abstract fun readByte(): Byte

Removes a byte from this source and returns it.

jvm

abstract fun readByte(): Byte

readByteArray

common

abstract fun readByteArray(): ByteArray

Removes all bytes from this and returns them as a byte array.

jvm

abstract fun readByteArray(): ByteArray

common

abstract fun readByteArray(byteCount: Long): ByteArray

Removes byteCount bytes from this and returns them as a byte array.

jvm

abstract fun readByteArray(byteCount: Long): ByteArray

readByteString

common

abstract fun readByteString(): ByteString

Removes all bytes from this and returns them as a byte string.

jvm

abstract fun readByteString(): ByteString

common

abstract fun readByteString(byteCount: Long): ByteString

Removes byteCount bytes from this and returns them as a byte string.

jvm

abstract fun readByteString(byteCount: Long): ByteString

readDecimalLong

common

abstract fun readDecimalLong(): Long

Reads a long from this source in signed decimal form (i.e., as a string in base 10 with optional leading '-').

jvm

abstract fun readDecimalLong(): Long

readFully

common

abstract fun readFully(sink: ByteArray)

Removes exactly sink.length bytes from this and copies them into sink.

jvm

abstract fun readFully(sink: ByteArray)

common

abstract fun readFully(sink: Buffer, byteCount: Long)

Removes exactly byteCount bytes from this and appends them to sink.

jvm

abstract fun readFully(sink: Buffer, byteCount: Long)

readHexadecimalUnsignedLong

common

abstract fun readHexadecimalUnsignedLong(): Long

Reads a long form this source in hexadecimal form (i.e., as a string in base 16).

jvm

abstract fun readHexadecimalUnsignedLong(): Long

readInt

common

abstract fun readInt(): Int

Removes four bytes from this source and returns a big-endian int.

jvm

abstract fun readInt(): Int

readIntLe

common

abstract fun readIntLe(): Int

Removes four bytes from this source and returns a little-endian int.

jvm

abstract fun readIntLe(): Int

readLong

common

abstract fun readLong(): Long

Removes eight bytes from this source and returns a big-endian long.

jvm

abstract fun readLong(): Long

readLongLe

common

abstract fun readLongLe(): Long

Removes eight bytes from this source and returns a little-endian long.

jvm

abstract fun readLongLe(): Long

readShort

common

abstract fun readShort(): Short

Removes two bytes from this source and returns a big-endian short.

jvm

abstract fun readShort(): Short

readShortLe

common

abstract fun readShortLe(): Short

Removes two bytes from this source and returns a little-endian short.

jvm

abstract fun readShortLe(): Short

readString

jvm

abstract fun readString(charset: Charset): String

Removes all bytes from this, decodes them as charset, and returns the string.

abstract fun readString(byteCount: Long, charset: Charset): String

Removes byteCount bytes from this, decodes them as charset, and returns the string.

readUtf8

common

abstract fun readUtf8(): String

Removes all bytes from this, decodes them as UTF-8, and returns the string.

jvm

abstract fun readUtf8(): String

common

abstract fun readUtf8(byteCount: Long): String

Removes byteCount bytes from this, decodes them as UTF-8, and returns the string.

jvm

abstract fun readUtf8(byteCount: Long): String

readUtf8CodePoint

common

abstract fun readUtf8CodePoint(): Int

Removes and returns a single UTF-8 code point, reading between 1 and 4 bytes as necessary.

jvm

abstract fun readUtf8CodePoint(): Int

readUtf8Line

common

abstract fun readUtf8Line(): String?

Removes and returns characters up to but not including the next line break.

jvm

abstract fun readUtf8Line(): String?

readUtf8LineStrict

common

abstract fun readUtf8LineStrict(): String

Removes and returns characters up to but not including the next line break.

jvm

abstract fun readUtf8LineStrict(): String

common

abstract fun readUtf8LineStrict(limit: Long): String

Like readUtf8LineStrict, except this allows the caller to specify the longest allowed match.

jvm

abstract fun readUtf8LineStrict(limit: Long): String

request

common

abstract fun request(byteCount: Long): Boolean

Returns true when the buffer contains at least byteCount bytes, expanding it as necessary.

jvm

abstract fun request(byteCount: Long): Boolean

require

common

abstract fun require(byteCount: Long)

Returns when the buffer contains at least byteCount bytes.

jvm

abstract fun require(byteCount: Long)

select

common

abstract fun select(options: Options): Int

Finds the first string in options that is a prefix of this buffer, consumes it from this buffer, and returns its index.

jvm

abstract fun select(options: Options): Int

skip

common

abstract fun skip(byteCount: Long)

Reads and discards byteCount bytes from this source.

jvm

abstract fun skip(byteCount: Long)

timeout

common

abstract fun timeout(): Timeout

Returns the timeout for this source.

jvm

abstract fun timeout(): Timeout

Returns the timeout for this source.

toString

open fun toString(): String

Properties

buffer

abstract val buffer: Buffer

This source's internal buffer.

abstract val buffer: Buffer

Inheritors

Buffer