1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
/*
* Copyright (C) 2019 Square, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package okio
/**
* Receives a stream of bytes. Use this interface to write data wherever it's needed: to the
* network, storage, or a buffer in memory. Sinks may be layered to transform received data, such as
* to compress, encrypt, throttle, or add protocol framing.
*
* Most application code shouldn't operate on a sink directly, but rather on a [BufferedSink] which
* is both more efficient and more convenient. Use [buffer] to wrap any sink with a buffer.
*
* Sinks are easy to test: just use a [Buffer] in your tests, and read from it to confirm it
* received the data that was expected.
*
* ### Comparison with OutputStream
*
* This interface is functionally equivalent to [java.io.OutputStream].
*
* `OutputStream` requires multiple layers when emitted data is heterogeneous: a `DataOutputStream`
* for primitive values, a `BufferedOutputStream` for buffering, and `OutputStreamWriter` for
* charset encoding. This library uses `BufferedSink` for all of the above.
*
* Sink is also easier to layer: there is no [write()][java.io.OutputStream.write] method that is
* awkward to implement efficiently.
*
* ### Interop with OutputStream
*
* Use [sink] to adapt an `OutputStream` to a sink. Use [outputStream()][BufferedSink.outputStream]
* to adapt a sink to an `OutputStream`.
*/
expect interface Sink : Closeable {
/** Removes `byteCount` bytes from `source` and appends them to this. */
@Throws(IOException::class)
fun write(source: Buffer, byteCount: Long)
/** Pushes all buffered bytes to their final destination. */
@Throws(IOException::class)
fun flush()
/** Returns the timeout for this sink. */
fun timeout(): Timeout
/**
* 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.
*/
@Throws(IOException::class)
override fun close()
}
|
