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 |
x40
x40
x40
x40
x40
x40
x56
x56
x56
x56
x56
x56
x56
x216
x56
x56
x216
x72
x56
x56
x56
x40
x40
x40
x51
x51
x51
x51
x40
x56
x56
x40
x56
x56
x40 |
|
// Copyright 2018-2025 the Deno authors. MIT license.
import { toByteStream } from "@std/streams/unstable-to-byte-stream";
import { CborSequenceEncoderStream } from "./sequence_encoder_stream.ts";
import type { CborStreamInput } from "./types.ts";
/**
* A {@link TransformStream} that encodes a
* {@link ReadableStream<CborStreamInput>} into CBOR "Indefinite Length Array".
* [RFC 8949 - Concise Binary Object Representation (CBOR)](https://datatracker.ietf.org/doc/html/rfc8949)
*
* @example Usage
* ```ts
* import { assert, assertEquals } from "@std/assert";
* import {
* CborArrayDecodedStream,
* CborArrayEncoderStream,
* CborSequenceDecoderStream,
* } from "@std/cbor";
*
* const rawMessage = ["a".repeat(100), "b".repeat(100), "c".repeat(100)];
*
* for await (
* const value of ReadableStream.from(rawMessage)
* .pipeThrough(new CborArrayEncoderStream())
* .pipeThrough(new CborSequenceDecoderStream())
* ) {
* assert(value instanceof CborArrayDecodedStream);
* let i = 0;
* for await (const text of value) {
* assert(typeof text === "string");
* assertEquals(text, rawMessage[i++]);
* }
* }
* ```
*/
export class CborArrayEncoderStream
implements TransformStream<CborStreamInput, Uint8Array> {
#readable: ReadableStream<Uint8Array>;
#writable: WritableStream<CborStreamInput>;
/**
* Constructs a new instance.
*/
constructor() {
const { readable, writable } = new TransformStream<
CborStreamInput,
CborStreamInput
>();
this.#readable = toByteStream(
readable
.pipeThrough(new CborSequenceEncoderStream())
.pipeThrough(
new TransformStream({
start(controller) {
controller.enqueue(new Uint8Array([0b100_11111]));
},
flush(controller) {
controller.enqueue(new Uint8Array([0b111_11111]));
},
}),
),
);
this.#writable = writable;
}
/**
* Creates a {@link CborArrayEncoderStream} instance from an iterable of
* {@link CborStreamInput} chunks.
*
* @example Usage
* ```ts
* import { assert, assertEquals } from "@std/assert";
* import {
* CborArrayDecodedStream,
* CborArrayEncoderStream,
* CborSequenceDecoderStream,
* } from "@std/cbor";
*
* const rawMessage = ["a".repeat(100), "b".repeat(100), "c".repeat(100)];
*
* for await (
* const value of CborArrayEncoderStream.from(rawMessage)
* .readable
* .pipeThrough(new CborSequenceDecoderStream())
* ) {
* assert(value instanceof CborArrayDecodedStream);
* let i = 0;
* for await (const text of value) {
* assert(typeof text === "string");
* assertEquals(text, rawMessage[i++]);
* }
* }
* ```
*
* @param asyncIterable The value to encode of type
* {@link AsyncIterable<CborStreamInput>} or
* {@link Iterable<CborStreamInput>}.
* @returns A {@link CborArrayEncoderStream} instance of the encoded data.
*/
static from(
asyncIterable: AsyncIterable<CborStreamInput> | Iterable<CborStreamInput>,
): CborArrayEncoderStream {
const encoder = new CborArrayEncoderStream();
ReadableStream.from(asyncIterable).pipeTo(encoder.writable);
return encoder;
}
/**
* The {@link ReadableStream<Uint8Array>} associated with the instance, which
* provides the encoded CBOR data as {@link Uint8Array} chunks.
*
* @example Usage
* ```ts
* import { assert, assertEquals } from "@std/assert";
* import {
* CborArrayDecodedStream,
* CborArrayEncoderStream,
* CborSequenceDecoderStream,
* } from "@std/cbor";
*
* const rawMessage = ["a".repeat(100), "b".repeat(100), "c".repeat(100)];
*
* for await (
* const value of ReadableStream.from(rawMessage)
* .pipeThrough(new CborArrayEncoderStream())
* .pipeThrough(new CborSequenceDecoderStream())
* ) {
* assert(value instanceof CborArrayDecodedStream);
* let i = 0;
* for await (const text of value) {
* assert(typeof text === "string");
* assertEquals(text, rawMessage[i++]);
* }
* }
* ```
*
* @returns A {@link ReadableStream<Uint8Array>}.
*/
get readable(): ReadableStream<Uint8Array> {
return this.#readable;
}
/**
* The {@link WritableStream<CborStreamInput>} associated with the instance,
* which accepts {@link CborStreamInput} chunks to be encoded into CBOR
* format.
*
* @example Usage
* ```ts
* import { assert, assertEquals } from "@std/assert";
* import {
* CborArrayDecodedStream,
* CborArrayEncoderStream,
* CborSequenceDecoderStream,
* } from "@std/cbor";
*
* const rawMessage = ["a".repeat(100), "b".repeat(100), "c".repeat(100)];
*
* for await (
* const value of ReadableStream.from(rawMessage)
* .pipeThrough(new CborArrayEncoderStream())
* .pipeThrough(new CborSequenceDecoderStream())
* ) {
* assert(value instanceof CborArrayDecodedStream);
* let i = 0;
* for await (const text of value) {
* assert(typeof text === "string");
* assertEquals(text, rawMessage[i++]);
* }
* }
* ```
*
* @returns A {@link WritableStream<CborStreamInput>}.
*/
get writable(): WritableStream<CborStreamInput> {
return this.#writable;
}
}
|