resynth 0.5.0

A packet synthesis language
Documentation 
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341

 # Standard types

 Core type conversion and utility functions available in every resynth program.
## Index


### Functions

| Function | Returns | Description |
| -------- | ------- | ----------- |
| [be16](#be16) | `bytes` | Encode a 16bit integer into 2 big-endian bytes |
| [be32](#be32) | `bytes` | Encode a 32bit integer into 4 big-endian bytes |
| [be64](#be64) | `bytes` | Encode a 64bit integer into 8 big-endian bytes |
| [le16](#le16) | `bytes` | Encode a 16bit integer into 2 little-endian bytes |
| [le32](#le32) | `bytes` | Encode a 32bit integer into 4 little-endian bytes |
| [le64](#le64) | `bytes` | Encode a 64bit integer into 8 little-endian bytes |
| [len_be16](#len_be16) | `bytes` | Prefix a buffer with a 16-bit big-endian length field |
| [len_be32](#len_be32) | `bytes` | Prefix a buffer with a 32-bit big-endian length field |
| [len_be64](#len_be64) | `bytes` | Prefix a buffer with a 64-bit big-endian length field |
| [len_le16](#len_le16) | `bytes` | Prefix a buffer with a 16-bit little-endian length field |
| [len_le32](#len_le32) | `bytes` | Prefix a buffer with a 32-bit little-endian length field |
| [len_le64](#len_le64) | `bytes` | Prefix a buffer with a 64-bit little-endian length field |
| [len_u8](#len_u8) | `bytes` | Prefix a buffer with an 8-bit byte length field |
| [u8](#u8) | `bytes` | Convert an integer into a one-byte string |



## be16
```resynth
resynth fn be16 (
    val: u64,
) -> bytes;
```
Encode a 16bit integer into 2 big-endian bytes

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u64` | Integer value to encode |

### Returns

| Type |
| ---- |
| `bytes` |

## be32
```resynth
resynth fn be32 (
    val: u64,
) -> bytes;
```
Encode a 32bit integer into 4 big-endian bytes

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u64` | Integer value to encode |

### Returns

| Type |
| ---- |
| `bytes` |

## be64
```resynth
resynth fn be64 (
    val: u64,
) -> bytes;
```
Encode a 64bit integer into 8 big-endian bytes

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u64` | Integer value to encode |

### Returns

| Type |
| ---- |
| `bytes` |

## le16
```resynth
resynth fn le16 (
    val: u64,
) -> bytes;
```
Encode a 16bit integer into 2 little-endian bytes

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u64` | Integer value to encode |

### Returns

| Type |
| ---- |
| `bytes` |

## le32
```resynth
resynth fn le32 (
    val: u64,
) -> bytes;
```
Encode a 32bit integer into 4 little-endian bytes

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u64` | Integer value to encode |

### Returns

| Type |
| ---- |
| `bytes` |

## le64
```resynth
resynth fn le64 (
    val: u64,
) -> bytes;
```
Encode a 64bit integer into 8 little-endian bytes

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u64` | Integer value to encode |

### Returns

| Type |
| ---- |
| `bytes` |

## len_be16
```resynth
resynth fn len_be16 (
    adjust: u16 = 0x0000,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with a 16-bit big-endian length field

 Prepends a 2-byte big-endian encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u16` | Adjustment value added to the computed length before encoding _(default: `0x0000`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## len_be32
```resynth
resynth fn len_be32 (
    adjust: u32 = 0x00000000,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with a 32-bit big-endian length field

 Prepends a 4-byte big-endian encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u32` | Adjustment value added to the computed length before encoding _(default: `0x00000000`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## len_be64
```resynth
resynth fn len_be64 (
    adjust: u64 = 0x0000000000000000,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with a 64-bit big-endian length field

 Prepends an 8-byte big-endian encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u64` | Adjustment value added to the computed length before encoding _(default: `0x0000000000000000`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## len_le16
```resynth
resynth fn len_le16 (
    adjust: u16 = 0x0000,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with a 16-bit little-endian length field

 Prepends a 2-byte little-endian encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u16` | Adjustment value added to the computed length before encoding _(default: `0x0000`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## len_le32
```resynth
resynth fn len_le32 (
    adjust: u32 = 0x00000000,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with a 32-bit little-endian length field

 Prepends a 4-byte little-endian encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u32` | Adjustment value added to the computed length before encoding _(default: `0x00000000`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## len_le64
```resynth
resynth fn len_le64 (
    adjust: u64 = 0x0000000000000000,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with a 64-bit little-endian length field

 Prepends an 8-byte little-endian encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u64` | Adjustment value added to the computed length before encoding _(default: `0x0000000000000000`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## len_u8
```resynth
resynth fn len_u8 (
    adjust: u8 = 0x00,
    =>
    *collect_args: bytes,
) -> bytes;
```
Prefix a buffer with an 8-bit byte length field

 Prepends a single byte encoding of `len(payload) + adjust` to the payload bytes.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `adjust` | `u8` | Adjustment value added to the computed length before encoding _(default: `0x00`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |

## u8
```resynth
resynth fn u8 (
    val: u8,
) -> bytes;
```
Convert an integer into a one-byte string

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `val` | `u8` | Integer value to encode as a single byte |

### Returns

| Type |
| ---- |
| `bytes` |