okio/okio/InflaterSource

InflaterSource

actual class InflaterSource : Source

expect class InflaterSource : Source

A source that uses DEFLATE to decompress data read from another source.

Constructors

InflaterSource

actual constructor(source: Source, inflater: Inflater)

expect constructor(source: Source, inflater: Inflater)

Functions

buffer

fun Source.buffer(): BufferedSource

Returns a new source that buffers reads from source. The returned source will perform bulk reads into its in-memory buffer. Use this wherever you read a source to get an ergonomic and efficient access to data.

cipherSource

fun Source.cipherSource(cipher: Cipher): CipherSource

Returns a source that uses cipher to encrypt or decrypt this.

actual open override fun close()

Closes this source and releases the resources held by this source. It is an error to read a closed source. It is safe to close a source more than once.

actual open override fun close()

expect open override fun close()

Closes this source and releases the resources held by this source. It is an error to read a closed source. It is safe to close a source more than once.

gzip

inline fun Source.gzip(): GzipSource

Returns a GzipSource that gzip-decompresses this Source while reading.

hashingSource

fun Source.hashingSource(digest: MessageDigest): HashingSource

Returns a source that uses digest to hash this.

fun Source.hashingSource(mac: Mac): HashingSource

Returns a source that uses mac to hash this.

inflate

inline fun Source.inflate(inflater: Inflater = Inflater()): InflaterSource

Returns an InflaterSource that DEFLATE-decompresses this Source while reading.

read

actual open override fun read(sink: Buffer, byteCount: Long): Long

Removes at least 1, and up to byteCount bytes from this and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

actual open override fun read(sink: Buffer, byteCount: Long): Long

expect open override fun read(sink: Buffer, byteCount: Long): Long

Removes at least 1, and up to byteCount bytes from this and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

readOrInflate

fun readOrInflate(sink: Buffer, byteCount: Long): Long

Consume deflated bytes from the underlying source, and write any inflated bytes to sink. Returns the number of inflated bytes written to sink. This may return 0L, though it will always consume 1 or more bytes from the underlying source if it is not exhausted.

refill

fun refill(): Boolean

Refills the inflater with compressed data if it needs input. (And only if it needs input). Returns true if the inflater required input but the source was exhausted.

timeout

actual open override fun timeout(): Timeout

Returns the timeout for this source.

actual open override fun timeout(): Timeout

expect open override fun timeout(): Timeout

Returns the timeout for this source.