deno.land / std@0.166.0 / streams / buffer.ts

نووسراو ببینە
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
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.import { assert } from "../_util/asserts.ts";import { copy } from "../bytes/mod.ts";
const MAX_SIZE = 2 ** 32 - 2;const DEFAULT_CHUNK_SIZE = 16_640;
/** A variable-sized buffer of bytes with `read()` and `write()` methods. * * Buffer is almost always used with some I/O like files and sockets. It allows * one to buffer up a download from a socket. Buffer grows and shrinks as * necessary. * * Buffer is NOT the same thing as Node's Buffer. Node's Buffer was created in * 2009 before JavaScript had the concept of ArrayBuffers. It's simply a * non-standard ArrayBuffer. * * ArrayBuffer is a fixed memory allocation. Buffer is implemented on top of * ArrayBuffer. * * Based on [Go Buffer](https://golang.org/pkg/bytes/#Buffer). */export class Buffer { #buf: Uint8Array; // contents are the bytes buf[off : len(buf)] #off = 0; // read at buf[off], write at buf[buf.byteLength] #readable: ReadableStream<Uint8Array> = new ReadableStream({ type: "bytes", pull: (controller) => { const view = new Uint8Array(controller.byobRequest!.view!.buffer); if (this.empty()) { // Buffer is empty, reset to recover space. this.reset(); controller.close(); controller.byobRequest!.respond(0); return; } const nread = copy(this.#buf.subarray(this.#off), view); this.#off += nread; controller.byobRequest!.respond(nread); }, autoAllocateChunkSize: DEFAULT_CHUNK_SIZE, }); get readable() { return this.#readable; } #writable = new WritableStream<Uint8Array>({ write: (chunk) => { const m = this.#grow(chunk.byteLength); copy(chunk, this.#buf, m); }, }); get writable() { return this.#writable; }
constructor(ab?: ArrayBufferLike | ArrayLike<number>) { this.#buf = ab === undefined ? new Uint8Array(0) : new Uint8Array(ab); }
/** Returns a slice holding the unread portion of the buffer. * * The slice is valid for use only until the next buffer modification (that * is, only until the next call to a method like `read()`, `write()`, * `reset()`, or `truncate()`). If `options.copy` is false the slice aliases the buffer content at * least until the next buffer modification, so immediate changes to the * slice will affect the result of future reads. * @param options Defaults to `{ copy: true }` */ bytes(options = { copy: true }): Uint8Array { if (options.copy === false) return this.#buf.subarray(this.#off); return this.#buf.slice(this.#off); }
/** Returns whether the unread portion of the buffer is empty. */ empty(): boolean { return this.#buf.byteLength <= this.#off; }
/** A read only number of bytes of the unread portion of the buffer. */ get length(): number { return this.#buf.byteLength - this.#off; }
/** The read only capacity of the buffer's underlying byte slice, that is, * the total space allocated for the buffer's data. */ get capacity(): number { return this.#buf.buffer.byteLength; }
/** Discards all but the first `n` unread bytes from the buffer but * continues to use the same allocated storage. It throws if `n` is * negative or greater than the length of the buffer. */ truncate(n: number) { if (n === 0) { this.reset(); return; } if (n < 0 || n > this.length) { throw Error("bytes.Buffer: truncation out of range"); } this.#reslice(this.#off + n); }
reset() { this.#reslice(0); this.#off = 0; }
#tryGrowByReslice(n: number) { const l = this.#buf.byteLength; if (n <= this.capacity - l) { this.#reslice(l + n); return l; } return -1; }
#reslice(len: number) { assert(len <= this.#buf.buffer.byteLength); this.#buf = new Uint8Array(this.#buf.buffer, 0, len); }
#grow(n: number) { const m = this.length; // If buffer is empty, reset to recover space. if (m === 0 && this.#off !== 0) { this.reset(); } // Fast: Try to grow by means of a reslice. const i = this.#tryGrowByReslice(n); if (i >= 0) { return i; } const c = this.capacity; if (n <= Math.floor(c / 2) - m) { // We can slide things down instead of allocating a new // ArrayBuffer. We only need m+n <= c to slide, but // we instead let capacity get twice as large so we // don't spend all our time copying. copy(this.#buf.subarray(this.#off), this.#buf); } else if (c + n > MAX_SIZE) { throw new Error("The buffer cannot be grown beyond the maximum size."); } else { // Not enough space anywhere, we need to allocate. const buf = new Uint8Array(Math.min(2 * c + n, MAX_SIZE)); copy(this.#buf.subarray(this.#off), buf); this.#buf = buf; } // Restore this.#off and len(this.#buf). this.#off = 0; this.#reslice(Math.min(m + n, MAX_SIZE)); return m; }
/** Grows the buffer's capacity, if necessary, to guarantee space for * another `n` bytes. After `.grow(n)`, at least `n` bytes can be written to * the buffer without another allocation. If `n` is negative, `.grow()` will * throw. If the buffer can't grow it will throw an error. * * Based on Go Lang's * [Buffer.Grow](https://golang.org/pkg/bytes/#Buffer.Grow). */ grow(n: number) { if (n < 0) { throw Error("Buffer.grow: negative count"); } const m = this.#grow(n); this.#reslice(m); }}
/** A TransformStream that will only read & enqueue `size` amount of bytes. * This operation is chunk based and not BYOB based, * and as such will read more than needed. * * if options.error is set, then instead of terminating the stream, * an error will be thrown. * * ```ts * import { LimitedBytesTransformStream } from "https://deno.land/std@$STD_VERSION/streams/buffer.ts"; * const res = await fetch("https://example.com"); * const parts = res.body! * .pipeThrough(new LimitedBytesTransformStream(512 * 1024)); * ``` */export class LimitedBytesTransformStream extends TransformStream<Uint8Array, Uint8Array> { #read = 0; constructor(size: number, options: { error?: boolean } = {}) { super({ transform: (chunk, controller) => { if ((this.#read + chunk.byteLength) > size) { if (options.error) { throw new RangeError(`Exceeded byte size limit of '${size}'`); } else { controller.terminate(); } } else { this.#read += chunk.byteLength; controller.enqueue(chunk); } }, }); }}
/** A TransformStream that will only read & enqueue `size` amount of chunks. * * if options.error is set, then instead of terminating the stream, * an error will be thrown. * * ```ts * import { LimitedTransformStream } from "https://deno.land/std@$STD_VERSION/streams/buffer.ts"; * const res = await fetch("https://example.com"); * const parts = res.body!.pipeThrough(new LimitedTransformStream(50)); * ``` */export class LimitedTransformStream<T> extends TransformStream<T, T> { #read = 0; constructor(size: number, options: { error?: boolean } = {}) { super({ transform: (chunk, controller) => { if ((this.#read + 1) > size) { if (options.error) { throw new RangeError(`Exceeded chunk limit of '${size}'`); } else { controller.terminate(); } } else { this.#read++; controller.enqueue(chunk); } }, }); }}
/** * A transform stream that only transforms from the zero-indexed `start` and `end` bytes (both inclusive). * * @example * ```ts * import { ByteSliceStream } from "https://deno.land/std@$STD_VERSION/streams/buffer.ts"; * const response = await fetch("https://example.com"); * const rangedStream = response.body! * .pipeThrough(new ByteSliceStream(3, 8)); * ``` */export class ByteSliceStream extends TransformStream<Uint8Array, Uint8Array> { #offsetStart = 0; #offsetEnd = 0;
constructor(start = 0, end = Infinity) { super({ start: () => { assert(start >= 0, "`start` must be greater than 0"); end += 1; }, transform: (chunk, controller) => { this.#offsetStart = this.#offsetEnd; this.#offsetEnd += chunk.byteLength; if (this.#offsetEnd > start) { if (this.#offsetStart < start) { chunk = chunk.slice(start - this.#offsetStart); } if (this.#offsetEnd >= end) { chunk = chunk.slice(0, chunk.byteLength - this.#offsetEnd + end); controller.enqueue(chunk); controller.terminate(); } else { controller.enqueue(chunk); } } }, }); }}
std
Deno standard library
GitHub Repositorydenoland/deno_std
GitHub Stars
2458

Version Info

Tagged at
2 months ago