okio/okio/HashingSink

HashingSink

A sink that computes a hash of the full stream of bytes it has accepted. To use, create an instance with your preferred hash algorithm. Write all of the data to the sink and then call hash to compute the final hash value.

In this example we use HashingSink with a BufferedSink to make writing to the sink easier.

HashingSink hashingSink = HashingSink.sha256(s);
BufferedSink bufferedSink = Okio.buffer(hashingSink);

... // Write to bufferedSink and either flush or close it.

ByteString hash = hashingSink.hash();

actual class HashingSink : ForwardingSink, Sink

In this example we use HashingSink with a BufferedSink to make writing to the sink easier.

HashingSink hashingSink = HashingSink.sha256(s);
BufferedSink bufferedSink = Okio.buffer(hashingSink);

... // Write to bufferedSink and either flush or close it.

ByteString hash = hashingSink.hash();

actual class HashingSink : Sink

Types

Companion

expect object Companion

actual object Companion

Properties

delegate

@get:JvmName(name = "delegate")

val delegate: Sink

Sink to which this instance is delegating.

hash

expect val hash: ByteString

Returns the hash of the bytes accepted thus far and resets the internal state of this sink.

@get:JvmName(name = "hash")

actual val hash: ByteString

Returns the hash of the bytes accepted thus far and resets the internal state of this sink.

actual val hash: ByteString

Returns the hash of the bytes accepted thus far and resets the internal state of this sink.

Functions

buffer

fun Sink.buffer(): BufferedSink

Returns a new sink that buffers writes to sink. The returned sink will batch writes to sink. Use this wherever you write to a sink to get an ergonomic and efficient access to data.

cipherSink

fun Sink.cipherSink(cipher: Cipher): CipherSink

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

expect abstract override fun close()

Pushes all buffered bytes to their final destination and releases the resources held by this sink. It is an error to write a closed sink. It is safe to close a sink more than once.

open override fun close()

deflate