okio/okio/CipherSource

CipherSource

class CipherSource(source: BufferedSource, val cipher: Cipher) : Source

Constructors

CipherSource

constructor(source: BufferedSource, cipher: Cipher)

Properties

cipher

val cipher: Cipher

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.

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

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.

timeout

open override fun timeout(): Timeout

Returns the timeout for this source.