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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
/*
* 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
/**
* A sink that keeps a buffer internally so that callers can do small writes without a performance
* penalty.
*/
expect interface BufferedSink : Sink {
/** This sink's internal buffer. */
val buffer: Buffer
fun write(byteString: ByteString): BufferedSink
fun write(byteString: ByteString, offset: Int, byteCount: Int): BufferedSink
/** Like [OutputStream.write], this writes a complete byte array to this sink. */
fun write(source: ByteArray): BufferedSink
/** Like [OutputStream.write], this writes `byteCount` bytes of `source`, starting at `offset`. */
fun write(source: ByteArray, offset: Int, byteCount: Int): BufferedSink
/**
* Removes all bytes from `source` and appends them to this sink. Returns the number of bytes read
* which will be 0 if `source` is exhausted.
*/
fun writeAll(source: Source): Long
/** Removes `byteCount` bytes from `source` and appends them to this sink. */
fun write(source: Source, byteCount: Long): BufferedSink
/**
* Encodes `string` in UTF-8 and writes it to this sink.
* ```
* Buffer buffer = new Buffer();
* buffer.writeUtf8("Uh uh uh!");
* buffer.writeByte(' ');
* buffer.writeUtf8("You didn't say the magic word!");
*
* assertEquals("Uh uh uh! You didn't say the magic word!", buffer.readUtf8());
* ```
*/
fun writeUtf8(string: String): BufferedSink
/**
* Encodes the characters at `beginIndex` up to `endIndex` from `string` in UTF-8 and writes it to
* this sink.
* ```
* Buffer buffer = new Buffer();
* buffer.writeUtf8("I'm a hacker!\n", 6, 12);
* buffer.writeByte(' ');
* buffer.writeUtf8("That's what I said: you're a nerd.\n", 29, 33);
* buffer.writeByte(' ');
* buffer.writeUtf8("I prefer to be called a hacker!\n", 24, 31);
*
* assertEquals("hacker nerd hacker!", buffer.readUtf8());
* ```
*/
fun writeUtf8(string: String, beginIndex: Int, endIndex: Int): BufferedSink
/** Encodes `codePoint` in UTF-8 and writes it to this sink. */
fun writeUtf8CodePoint(codePoint: Int): BufferedSink
/** Writes a byte to this sink. */
fun writeByte(b: Int): BufferedSink
/**
* Writes a big-endian short to this sink using two bytes.
* ```
* Buffer buffer = new Buffer();
* buffer.writeShort(32767);
* buffer.writeShort(15);
*
* assertEquals(4, buffer.size());
* assertEquals((byte) 0x7f, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x0f, buffer.readByte());
* assertEquals(0, buffer.size());
* ```
*/
fun writeShort(s: Int): BufferedSink
/**
* Writes a little-endian short to this sink using two bytes.
* ```
* Buffer buffer = new Buffer();
* buffer.writeShortLe(32767);
* buffer.writeShortLe(15);
*
* assertEquals(4, buffer.size());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0x7f, buffer.readByte());
* assertEquals((byte) 0x0f, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals(0, buffer.size());
* ```
*/
fun writeShortLe(s: Int): BufferedSink
/**
* Writes a big-endian int to this sink using four bytes.
* ```
* Buffer buffer = new Buffer();
* buffer.writeInt(2147483647);
* buffer.writeInt(15);
*
* assertEquals(8, buffer.size());
* assertEquals((byte) 0x7f, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x0f, buffer.readByte());
* assertEquals(0, buffer.size());
* ```
*/
fun writeInt(i: Int): BufferedSink
/**
* Writes a little-endian int to this sink using four bytes.
* ```
* Buffer buffer = new Buffer();
* buffer.writeIntLe(2147483647);
* buffer.writeIntLe(15);
*
* assertEquals(8, buffer.size());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0x7f, buffer.readByte());
* assertEquals((byte) 0x0f, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals(0, buffer.size());
* ```
*/
fun writeIntLe(i: Int): BufferedSink
/**
* Writes a big-endian long to this sink using eight bytes.
* ```
* Buffer buffer = new Buffer();
* buffer.writeLong(9223372036854775807L);
* buffer.writeLong(15);
*
* assertEquals(16, buffer.size());
* assertEquals((byte) 0x7f, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x0f, buffer.readByte());
* assertEquals(0, buffer.size());
* ```
*/
fun writeLong(v: Long): BufferedSink
/**
* Writes a little-endian long to this sink using eight bytes.
* ```
* Buffer buffer = new Buffer();
* buffer.writeLongLe(9223372036854775807L);
* buffer.writeLongLe(15);
*
* assertEquals(16, buffer.size());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0xff, buffer.readByte());
* assertEquals((byte) 0x7f, buffer.readByte());
* assertEquals((byte) 0x0f, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals((byte) 0x00, buffer.readByte());
* assertEquals(0, buffer.size());
* ```
*/
fun writeLongLe(v: Long): BufferedSink
/**
* Writes a long to this sink in signed decimal form (i.e., as a string in base 10).
* ```
* Buffer buffer = new Buffer();
* buffer.writeDecimalLong(8675309L);
* buffer.writeByte(' ');
* buffer.writeDecimalLong(-123L);
* buffer.writeByte(' ');
* buffer.writeDecimalLong(1L);
*
* assertEquals("8675309 -123 1", buffer.readUtf8());
* ```
*/
fun writeDecimalLong(v: Long): BufferedSink
/**
* Writes a long to this sink in hexadecimal form (i.e., as a string in base 16).
* ```
* Buffer buffer = new Buffer();
* buffer.writeHexadecimalUnsignedLong(65535L);
* buffer.writeByte(' ');
* buffer.writeHexadecimalUnsignedLong(0xcafebabeL);
* buffer.writeByte(' ');
* buffer.writeHexadecimalUnsignedLong(0x10L);
*
* assertEquals("ffff cafebabe 10", buffer.readUtf8());
* ```
*/
fun writeHexadecimalUnsignedLong(v: Long): BufferedSink
/**
* Writes all buffered data to the underlying sink, if one exists. Then that sink is recursively
* flushed which pushes data as far as possible towards its ultimate destination. Typically that
* destination is a network socket or file.
* ```
* BufferedSink b0 = new Buffer();
* BufferedSink b1 = Okio.buffer(b0);
* BufferedSink b2 = Okio.buffer(b1);
*
* b2.writeUtf8("hello");
* assertEquals(5, b2.buffer().size());
* assertEquals(0, b1.buffer().size());
* assertEquals(0, b0.buffer().size());
*
* b2.flush();
* assertEquals(0, b2.buffer().size());
* assertEquals(0, b1.buffer().size());
* assertEquals(5, b0.buffer().size());
* ```
*/
override fun flush()
/**
* Writes all buffered data to the underlying sink, if one exists. Like [flush], but weaker. Call
* this before this buffered sink goes out of scope so that its data can reach its destination.
* ```
* BufferedSink b0 = new Buffer();
* BufferedSink b1 = Okio.buffer(b0);
* BufferedSink b2 = Okio.buffer(b1);
*
* b2.writeUtf8("hello");
* assertEquals(5, b2.buffer().size());
* assertEquals(0, b1.buffer().size());
* assertEquals(0, b0.buffer().size());
*
* b2.emit();
* assertEquals(0, b2.buffer().size());
* assertEquals(5, b1.buffer().size());
* assertEquals(0, b0.buffer().size());
*
* b1.emit();
* assertEquals(0, b2.buffer().size());
* assertEquals(0, b1.buffer().size());
* assertEquals(5, b0.buffer().size());
* ```
*/
fun emit(): BufferedSink
/**
* Writes complete segments to the underlying sink, if one exists. Like [flush], but weaker. Use
* this to limit the memory held in the buffer to a single segment. Typically application code
* will not need to call this: it is only necessary when application code writes directly to this
* [sink's buffer][buffer].
* ```
* BufferedSink b0 = new Buffer();
* BufferedSink b1 = Okio.buffer(b0);
* BufferedSink b2 = Okio.buffer(b1);
*
* b2.buffer().write(new byte[20_000]);
* assertEquals(20_000, b2.buffer().size());
* assertEquals( 0, b1.buffer().size());
* assertEquals( 0, b0.buffer().size());
*
* b2.emitCompleteSegments();
* assertEquals( 3_616, b2.buffer().size());
* assertEquals( 0, b1.buffer().size());
* assertEquals(16_384, b0.buffer().size()); // This example assumes 8192 byte segments.
* ```
*/
fun emitCompleteSegments(): BufferedSink
}
|
