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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
|
/*
* Copyright © 2025 Michael Smith <mikesmiffy128@gmail.com>
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
* REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
* LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef INC_CHUNKLETS_MSG_H
#define INC_CHUNKLETS_MSG_H
#ifdef __cplusplus
#define _msg_Bool bool
extern "C" {
#else
#define _msg_Bool _Bool
#endif
/*
* Writes a nil (null) message to the buffer `out`.
*
* `out` must point to at least 1 byte of space.
*
* Always writes a single byte.
*/
static inline void msg_putnil(unsigned char *out) {
*out = 0xC0;
}
/*
* Writes a nil (null) message immediately before the pointer `end`.
*
* `end` must point immediately beyond at least 1 byte of space.
*
* Always writes a single byte.
*
*/
static inline void msg_rputnil(unsigned char *end) {
end[-1] = 0xC0;
}
/*
* Writes the boolean `val` to the buffer `out`.
*
* `out` must point to at least 1 byte of space.
*
* Always writes a single byte.
*/
static inline void msg_putbool(unsigned char *out, _msg_Bool val) {
*out = 0xC2 | val;
}
/*
* Writes the boolean `val` immediately before the pointer `end`.
*
* `end` must point immediately beyond at least 1 byte of space.
*
* Always writes a single byte.
*/
static inline void msg_rputbool(unsigned char *end, _msg_Bool val) {
end[-1] = 0xC2 | val;
}
/*
* Writes the integer `val` in the range [-32, 127] to the buffer `out`. Values
* outside this range will produce an undefined encoding.
*
* `out` must point to at least 1 byte of space.
*
* Always writes a single byte.
*
* It is recommended to use msg_puts() for arbitrary signed values or msg_putu()
* for arbitrary unsigned values. Those functions will produce the smallest
* possible encoding for any value.
*/
static inline void msg_puti7(unsigned char *out, signed char val) {
*out = val; // a fixnum is just the literal byte! genius!
}
/*
* Writes the integer `val` in the range [-32, 127] immediately before the
* pointer `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond at least 1 byte of space.
*
* Always writes a single byte.
*
* It is recommended to use msg_rputs() for arbitrary signed values or
* msg_rputu() for arbitrary unsigned values. Those functions will produce the
* smallest possible encoding for any value.
*/
static inline void msg_rputi7(unsigned char *end, signed char val) {
end[-1] = val;
}
/*
* Writes the signed int `val` in the range [-128, 127] to the buffer `out`.
*
* `out` must point to at least 2 bytes of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* It is recommended to use msg_puts() for arbitrary signed values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_puts8(unsigned char *out, signed char val);
/*
* Writes the signed int `val` in the range [-128, 127] immediately before the
* pointer `end`.
*
* `end` must point immediately beyond at least 2 bytes of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* It is recommended to use msg_rputs() for arbitrary signed values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_rputs8(unsigned char *end, signed char val);
/*
* Writes the unsigned int `val` in the range [0, 255] to the buffer `out`.
*
* `out` must point to at least 2 bytes of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* It is recommended to use msg_putu() for arbitrary unsigned values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_putu8(unsigned char *out, unsigned char val);
/*
* Writes the unsigned int `val` in the range [0, 255] immediately before the
* pointer `end`.
*
* `end` must point immediately beyond at least 2 bytes of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* It is recommended to use msg_rputu() for arbitrary unsigned values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_rputu8(unsigned char *end, unsigned char val);
/*
* Writes the signed int `val` in the range [-32768, 32767] to the buffer `out`.
*
* `out` must point to at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3}.
*
* It is recommended to use msg_puts() for arbitrary signed values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_puts16(unsigned char *out, short val);
/*
* Writes the signed int `val` in the range [-32768, 32767] immediately before
* the pointer `end`.
*
* `end` must point immediately beyond at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3}.
*
* It is recommended to use msg_rputs() for arbitrary signed values. That
* function will produce the smallest possible encoding for any value.
*/
int mmsg_rputs16(unsigned char *end, short val);
/*
* Writes the unsigned int `val` in the range [0, 65536] to the buffer `out`.
*
* `out` must point to at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3}.
*
* It is recommended to use msg_putu() for arbitrary unsigned values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_putu16(unsigned char *out, unsigned short val);
/*
* Writes the signed int `val` in the range [0, 65536] immediately before the
* pointer `end`.
*
* `end` must point immediately beyond at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* It is recommended to use msg_rputu() for arbitrary unsigned values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_rputu16(unsigned char *end, unsigned short val);
/*
* Writes the signed int `val` in the range [-2147483648, 2147483647] to the
* buffer `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5}.
*
* It is recommended to use msg_puts() for arbitrary signed values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_puts32(unsigned char *out, int val);
/*
* Writes the signed int `val` in the range [-2147483648, 2147483647]
* immediately before the pointer `end`.
*
* `end` must point immediately beyond at least least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5}.
*
* It is recommended to use msg_rputs() for arbitrary signed values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_rputs32(unsigned char *end, int val);
/*
* Writes the unsigned int `val` in the range [0, 4294967295] to the buffer
* `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5}.
*
* It is recommended to use msg_putu() for arbitrary unsigned values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_putu32(unsigned char *out, unsigned int val);
/*
* Writes the unsigned int `val` in the range [0, 4294967295] immediately before
* the pointer `end`.
*
* `end` must point immediately beyond at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5}.
*
* It is recommended to use msg_rputu() for arbitrary unsigned values. That
* function will produce the smallest possible encoding for any value.
*/
int msg_rputu32(unsigned char *end, unsigned int val);
/*
* Writes the signed int `val` in the range [-9223372036854775808,
* 9223372036854775807] to the buffer `out`.
*
* `out` must point to at least 9 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5, 9}.
*/
int msg_puts(unsigned char *out, long long val);
/*
* Writes the signed int `val` in the range [-9223372036854775808,
* 9223372036854775807] immediately before the pointer `end`.
*
* `end` must point immediately beyond at least 9 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5, 9}.
*/
int msg_rputs(unsigned char *end, long long val);
/*
* Writes the unsigned int `val` in the range [0, 18446744073709551616] to the
* buffer `out`.
*
* `out` must point to at least 9 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5, 9}.
*/
int msg_putu(unsigned char *out, unsigned long long val);
/*
* Writes the unsigned int `val` in the range [0, 18446744073709551616]
* immediately before the pointer `end`.
*
* `end` must point immediately beyond at least 9 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5, 9}.
*/
int msg_rputu(unsigned char *end, unsigned long long val);
/*
* Writes the IEEE 754 single-precision float `val` to the buffer `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Always writes 5 bytes.
*/
void msg_putf(unsigned char *out, float val);
/*
* Writes the IEEE 754 single-precision float `val` immediately before the pointer
* `end`.
*
* `end` must point immediately beyond at least 5 bytes of space.
*
* Always writes 5 bytes.
*/
static inline void msg_rputf(unsigned char *end, float val) {
msg_putf(end - 5, val);
}
/*
* Writes the IEEE 754 double-precision float `val` to the buffer `out`, or writes
* a single-precision float if the exact value is the same.
*
* `out` must point to at least 9 bytes of space.
*
* Returns the number of bytes written, one of {5, 9}.
*/
int msg_putd(unsigned char *out, double val);
/*
* Writes the IEEE 754 double-precision float `val` immediately before the pointer
* `end`, or writes a single-precision float if the exact value is the same.
*
* `end` must point immediately beyond at least 9 bytes of space.
*
* Returns the number of bytes written, one of {5, 9}.
*/
int msg_rputd(unsigned char *end, double val);
/*
* Writes the string size `sz` in the range [0, 31] to the buffer `out`. Values
* outside this range will produce an undefined encoding.
*
* `out` must point to at least 1 byte of space.
*
* Always writes a single byte.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*
* It is recommended to use msg_putssz() for arbitrary string sizes. That
* function will produce the smallest possible encoding for any size value.
*/
static inline void msg_putssz5(unsigned char *out, int sz) {
*out = 0xA0 | sz;
}
/*
* Writes the string size `sz` in the range [0, 31] immediately before the pointer
* `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond at least 1 byte of space.
*
* Always writes a single byte.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*
* It is recommended to use msg_rputssz() for arbitrary string sizes. That
* function will produce the smallest possible encoding for any size value.
*/
static inline void msg_rputssz5(unsigned char *end, int sz) {
msg_putssz5(end - 1, sz);
}
/*
* Writes the string size `sz` in the range [0, 255] to the buffer `out`. Values
* outside this range will produce an undefined encoding.
*
* `out` must point to at least 2 bytes of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*
* It is recommended to use msg_putssz() for arbitrary string sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_putssz8(unsigned char *out, int sz);
/*
* Writes the string size `sz` in the range [0, 255] immediately before the
* pointer `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond at least 2 byte of space.
*
* Returns the number of bytes written, one of {1, 2}.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*
* It is recommended to use msg_rputssz() for arbitrary string sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_rputssz8(unsigned char *end, int sz);
/*
* Writes the string size `sz` in the range [0, 65535] to the buffer `out`. Values
* outside this range will produce an undefined encoding.
*
* `out` must point to at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3}.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*
* It is recommended to use msg_putssz() for arbitrary string sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_putssz16(unsigned char *out, int sz);
/*
* Writes the string size `sz` in the range [0, 65535] immediately before the
* pointer `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3}.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*
* It is recommended to use msg_rputssz() for arbitrary string sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_rputssz16(unsigned char *end, int sz);
/*
* Writes the string size `sz` in the range [0, 4294967295] to the buffer `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*/
int msg_putssz(unsigned char *out, unsigned int sz);
/*
* Writes the string size `sz` in the range [0, 4294967295] immediately before
* the pointer `end`.
*
* `end` must point immediately beyond at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 2, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by N
* bytes of the actual string, which must be valid UTF-8.
*/
int msg_rputssz(unsigned char *end, unsigned int sz);
/*
* Writes the binary blob size `sz` in the range [0, 255] to the buffer `out`.
* Values outside this range will produce an undefined encoding.
*
* `out` must point to at least 2 bytes of space.
*
* Always writes 2 bytes.
*
* In a complete message stream, a size of N must be immediately followed by
* N bytes of the actual data.
*
* It is recommended to use msg_putbsz() for arbitrary binary blob sizes. That
* function will produce the smallest possible encoding for any size value.
*/
static inline void msg_putbsz8(unsigned char *out, int sz) {
out[0] = 0xC4; out[1] = sz;
}
/*
* Writes the binary blob size `sz` in the range [0, 255] immediately before the
* pointer `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond at least 2 bytes of space.
*
* Always writes 2 bytes.
*
* In a complete message stream, a size of N must be immediately followed by
* N bytes of the actual data.
*
* It is recommended to use msg_rputbsz() for arbitrary binary blob sizes. That
* function will produce the smallest possible encoding for any size value.
*/
static inline void msg_rputbsz8(unsigned char *end, int sz) {
end[-2] = 0xC4; end[-1] = sz;
}
/*
* Writes the binary blob size `sz` in the range [0, 65535] to the buffer `out`.
* Values outside this range will produce an undefined encoding.
*
* `out` must point to at least 3 bytes of space.
*
* Returns the number of bytes written, one of {2, 3}.
*
* In a complete message stream, a size of N must be immediately followed by
* N bytes of the actual data.
*
* It is recommended to use msg_putbsz() for arbitrary binary blob sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_putbsz16(unsigned char *out, int sz);
/*
* Writes the binary blob size `sz` in the range [0, 65535] immediately before
* the pointer `end`. Values outside this range will produce an undefined
* encoding.
*
* `end` must point immediately beyond at least 3 bytes of space.
*
* Returns the number of bytes written, one of {2, 3}.
*
* In a complete message stream, a size of N must be immediately followed by
* N bytes of the actual data.
*
* It is recommended to use msg_rputbsz() for arbitrary binary blob sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_rputbsz16(unsigned char *end, int sz);
/*
* Writes the binary blob size `sz` in the range [0, 4294967295] to the buffer
* `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Returns the number of bytes written, one of {2, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by
* N bytes of the actual data.
*/
int msg_putbsz(unsigned char *out, unsigned int sz);
/*
* Writes the binary blob size `sz` in the range [0, 4294967295] immediately
* before the pointer `end`.
*
* `end` must point immediately beyond at least 5 bytes of space.
*
* Returns the number of bytes written, one of {2, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by
* N bytes of the actual data.
*/
int msg_rputbsz(unsigned char *end, unsigned int sz);
/*
* Writes the array size `sz` in the range [0, 15] to the buffer `out`. Values
* outside this range will produce an undefined encoding.
*
* `out` must point to at least 1 byte of space.
*
* Always writes a single byte.
*
* In a complete message stream, a size of N must be immediately followed by N
* other messages, which form the contents of the array.
*
* It is recommended to use msg_putasz() for arbitrary array sizes. That
* function will produce the smallest possible encoding for any size value.
*/
static inline void msg_putasz4(unsigned char *out, int sz) {
*out = 0x90 | sz;
}
/*
* Writes the array size `sz` in the range [0, 15] immediately before the
* pointer `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond at least 1 byte of space.
*
* Always writes a single byte.
*
* In a complete message stream, a size of N must be immediately followed by N
* other messages, which form the contents of the array.
*
* It is recommended to use msg_rputasz() for arbitrary array sizes. That
* function will produce the smallest possible encoding for any size value.
*/
static inline void msg_rputasz4(unsigned char *end, int sz) {
end[-1] = 0x90 | sz;
}
/*
* Writes the array size `sz` in the range [0, 65535] to the buffer `out`.
* Values outside this range will produce an undefined encoding.
*
* `out` must point to at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 3}.
*
* In a complete message stream, a size of N must be immediately followed by N
* other messages, which form the contents of the array.
*
* It is recommended to use msg_putasz() for arbitrary array sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_putasz16(unsigned char *out, int sz);
/*
* Writes the array size `sz` in the range [0, 65535] immediately before the
* pointer `end`.
*
* `end` must point immediately beyond at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 3}.
*
* In a complete message stream, a size of N must be immediately followed by N
* other messages, which form the contents of the array.
*
* It is recommended to use msg_rputasz() for arbitrary array sizes. That
* function will produce the smallest possible encoding for any size value.
*/
int msg_rputasz16(unsigned char *end, int sz);
/*
* Writes the array size `sz` in the range [0, 4294967295] to the buffer `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by N
* other messages, which form the contents of the array.
*/
int msg_putasz(unsigned char *out, unsigned int sz);
/*
* Writes the array size `sz` in the range [0, 4294967295] immediately before
* the pointer `end`.
*
* `end` must point immediately beyond at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by N
* other messages, which form the contents of the array.
*/
int msg_rputasz(unsigned char *end, unsigned int sz);
/*
* Writes the map size `sz` in the range [0, 15] to the buffer `out`. Values
* outside this range will produce an undefined encoding.
* `out` must point to at least 1 byte of space.
*
* Always writes a single byte.
*
* In a complete message stream, a size of N must be immediately followed by
* N other pairs of messages, each containing a key followed by a value, making
* up the contents of the map.
*
* It is recommended to use msg_putmsz() for arbitrary map sizes. That function
* will produce the smallest possible encoding for any size value.
*/
static inline void msg_putmsz4(unsigned char *out, int sz) {
*out = 0x80 | sz;
}
/*
* Writes the map size `sz` in the range [0, 15] immediately before the pointer
* `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately at least 1 byte of space.
*
* Always writes a single byte.
*
* In a complete message stream, a size of N must be immediately followed by
* N other pairs of messages, each containing a key followed by a value, making
* up the contents of the map.
*
* It is recommended to use msg_rputmsz() for arbitrary map sizes. That function
* will produce the smallest possible encoding for any size value.
*/
static inline void msg_rputmsz4(unsigned char *end, int sz) {
end[-1] = 0x80 | sz;
}
/*
* Writes the map size `sz` in the range [0, 65536] to the buffer `out`.
*
* `out` must point to at least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 3}.
*
* In a complete message stream, a size of N must be immediately followed by
* N * 2 other messages, which form the contents of the map as alternating
* pairs, each containing one key followed by one value.
*
* It is recommended to use msg_putmsz() for arbitrary map sizes. That function
* will produce the smallest possible encoding for any size value.
*/
int msg_putmsz16(unsigned char *out, int sz);
/*
* Writes the map size `sz` in the range [0, 65536] immediately before the
* pointer `end`. Values outside this range will produce an undefined encoding.
*
* `end` must point immediately beyond least 3 bytes of space.
*
* Returns the number of bytes written, one of {1, 3}.
*
* In a complete message stream, a size of N must be immediately followed by
* N other pairs of messages, each containing a key followed by a value, making
* up the contents of the map.
*
* It is recommended to use msg_rputmsz() for arbitrary map sizes. That function
* will produce the smallest possible encoding for any size value.
*/
int msg_rputmsz16(unsigned char *end, int sz);
/*
* Writes the map size `sz` in the range [0, 4294967295] to the buffer `out`.
*
* `out` must point to at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by
* N other pairs of messages, each containing a key followed by a value, making
* up the contents of the map.
*/
int msg_putmsz(unsigned char *out, unsigned int sz);
/*
* Writes the map size `sz` in the range [0, 4294967295] immediately before the
* pointer `end`.
*
* `end` must point immediately beyond at least 5 bytes of space.
*
* Returns the number of bytes written, one of {1, 3, 5}.
*
* In a complete message stream, a size of N must be immediately followed by
* N other pairs of messages, each containing a key followed by a value, making
* up the contents of the map.
*/
int msg_putmszr(unsigned char *end, unsigned int sz);
#ifdef __cplusplus
}
#endif
#undef _msg_Bool
#endif
// vi: sw=4 ts=4 noet tw=80 cc=80
|