tracelogging_dynamic 0.1.0

TraceLoggingDynamic for Rust
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
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
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

use alloc::vec::Vec;
use core::mem::size_of;
use core::ptr::copy_nonoverlapping;

use tracelogging::Channel;
use tracelogging::Guid;
use tracelogging::InType;
use tracelogging::Level;
use tracelogging::Opcode;
use tracelogging::OutType;
use tracelogging::_internal::EventDataDescriptor;
use tracelogging::_internal::EventDescriptor;

use crate::provider::Provider;

/// `EventBuilder` is a builder for events to be written through a [Provider].
///
/// # Overview
///
/// - Check [Provider::enabled], e.g. `my_provider.enabled(level, keyword)`, so that you
///   skip the remaining steps if no ETW logging sessions are listening for your event.
/// - Get an EventBuilder, e.g. `let mut builder = EventBuilder::new();`.
///   - EventBuilder is reusable. You may get a small performance improvement by reusing
///     builders instead of creating a new one for each event.
/// - Call `builder.reset("EventName", level, keyword, event_tag)` to begin building an event.
///   - The event name should be short and distinct. Don't use same name for two events in
///     the same provider that have different fields, levels, or keywords.
///   - level is the event severity.
///   - keyword is a bitmask indicating one or more event categories.
///   - event_tag is a 28-bit provider-defined value that will be included in the
///     metadata of the event. Use 0 if you are not using event tags.
/// - For each field of the event, call
///   `builder.add_TYPE("FieldName", field_value, OutType::OUTTYPE, field_tag)`.
///   - The method's TYPE suffix maps to an [InType] that specifies the encoding of the
///     field as well as the default formatting that should apply if [OutType::Default]
///     is used. For example, `add_hex32` maps to [InType::Hex32].
///   - The field name should be short and distinct.
///   - The OUTTYPE controls the formatting that will be used when the field is decoded.
///     Use [OutType::Default] to get the normal formatting based on the method's TYPE
///     suffix (i.e. the default format for the corresponding [InType]). Use other
///     [OutType] values when non-default formatting is needed. For example, `add_u8`
///     adds an [InType::U8] field to the event. The default format for [InType::U8] is
///     [OutType::Unsigned], so if you use `add_u8(..., OutType::Default, ...), the field
///     will be decoded as an unsigned decimal integer. However, if you specify
///     [OutType::String], the field will be formatted as a char, or if you specify
///     [OutType::Hex], the field will be formatted as a hexadecimal integer.
///     - Note that [OutType::Default] has a special encoding that saves 1 byte per
///       field, so prefer [OutType::Default] over other [OutType] values in cases where
///       they both do the same thing.
///   - field_tag is a 28-bit provider-defined value that will be included in the
///     metadata of the field. Use 0 if you are not using field tags.
/// - If appropriate, configure other event options by calling:
///   - `builder.id_version(id, ver)`
///   - `builder.channel(channel)`
///   - `builder.opcode(opcode)`
///   - `builder.task(task)`
/// - Call `builder.write(provider, activity_id, related_id)` to
///   send the event to ETW.
///   - `activity_id` is an optional 128-bit value that can be used during trace
///     analysis to group and correlate events. If `None`, the current thread's
///     thread-local activity id will be used as the event's activity id.
///   - `related_id` is an optional 128-bit value that indicates the parent of a
///     newly-started activity. This should be specified for
///     activity-[start](Opcode::Start) events and should be `None` for other events.
///
/// # Event Size Limits
///
/// ETW does not support events larger than the event consumer's buffer size. In
/// addition, regardless of the event consumer's buffer size, ETW does not support events
/// larger than 64KB. The event size includes event headers (provider id, activity id,
/// timestamp, event descriptor, etc.), metadata (provider name, event name, field names),
/// and data (field values). Events that are too large will cause builder.write to return
/// an error.
///
/// Most ETW decoding tools are unable to decode an event with more than 128 fields.
pub struct EventBuilder {
    meta: Vec<u8>,
    data: Vec<u8>,
    descriptor: EventDescriptor,
}

impl EventBuilder {
    /// Returns a new event builder with default initial buffer capacity.
    ///
    /// Default capacity is currently 256 bytes for meta and 256 bytes for data.
    /// Buffers will automatically grow as needed.
    pub fn new() -> EventBuilder {
        return Self::new_with_capacity(256, 256);
    }

    /// Returns a new event builder with specified initial buffer capacities.
    /// Buffers will automatically grow as needed.
    pub fn new_with_capacity(meta_capacity: u16, data_capacity: u16) -> EventBuilder {
        let mut b = EventBuilder {
            meta: Vec::with_capacity(if meta_capacity < 4 {
                4
            } else {
                meta_capacity as usize
            }),
            data: Vec::with_capacity(data_capacity as usize),
            descriptor: EventDescriptor::zero(),
        };
        b.meta.resize(4, 0); // u16 size = 0, u8 tag = 0, u8 name_nul_termination = 0;
        return b;
    }

    /// Clears the previous event (if any) from the builder and starts building a new
    /// event.
    ///
    /// name is the event name. It should be short and unique. It must not contain any
    /// `'\0'` bytes.
    ///
    /// level indicates the severity of the event. Use Verbose if unsure.
    ///
    /// keyword is a bitmask of category bits. The upper 16 bits are defined by Microsoft,
    /// and the low 48 bits are defined by the user on a per-provider basis, i.e. all
    /// providers with a particular name + id should use the same category bit assignments.
    /// For example, your provider might define 0x2 as the "networking" category bit and 0x4
    /// as the "threading" category bit. Keyword should always be a non-zero value. If
    /// category bits have not been defined for your provider, define 0x1 as "uncategorized"
    /// and use 0x1 as the keyword for all events.
    ///
    /// event_tag is a 28-bit integer (range 0x0 to 0x0FFFFFFF). Use 0 if you are
    /// not using event tags.
    pub fn reset(&mut self, name: &str, level: Level, keyword: u64, event_tag: u32) -> &mut Self {
        debug_assert!(!name.contains('\0'), "event name must not contain '\\0'");
        debug_assert_eq!(
            event_tag & 0x0FFFFFFF,
            event_tag,
            "event_tag must fit into 28 bits"
        );

        self.meta.clear();
        self.data.clear();
        self.descriptor = EventDescriptor::new(level, keyword);

        // Placeholder for u16 metadata size, filled-in by write.
        self.meta.push(0);
        self.meta.push(0);

        if (event_tag & 0x0FE00000) == event_tag {
            self.meta.push((event_tag >> 21) as u8);
        } else if (event_tag & 0x0FFFC000) == event_tag {
            self.meta.push((event_tag >> 21) as u8 | 0x80);
            self.meta.push((event_tag >> 14) as u8 & 0x7F);
        } else {
            self.meta.push((event_tag >> 21) as u8 | 0x80);
            self.meta.push((event_tag >> 14) as u8 | 0x80);
            self.meta.push((event_tag >> 7) as u8 | 0x80);
            self.meta.push(event_tag as u8 & 0x7F);
        }

        self.meta.extend_from_slice(name.as_bytes());
        self.meta.push(0); // nul termination

        return self;
    }

    /// Sends the built event to ETW via the specified provider.
    ///
    /// Returns 0 for success or a Win32 error from `EventWrite` for failure. The return
    /// value is for diagnostic purposes only and should generally be ignored in retail
    /// builds.
    ///
    /// provider: Should usually be a registered provider. Calling write on an
    /// unregistered provider is a no-op.
    ///
    /// activity_id: Contains the activity id to be used for the event. If None, the event will
    /// use the current thread's thread-local activity id for its activity id.
    ///
    /// related_id: Contains the related activity id (parent activity) to be used for the event.
    /// If None, the event will not have a related activity id. The related activity id should
    /// be set for activity-start events and should be None for other events.
    pub fn write(
        &mut self,
        provider: &Provider,
        activity_id: Option<&Guid>,
        related_id: Option<&Guid>,
    ) -> u32 {
        let result;
        let meta_len = self.meta.len();
        if meta_len > 65535 {
            result = 534; // ERROR_ARITHMETIC_OVERFLOW
        } else {
            self.meta[0] = meta_len as u8;
            self.meta[1] = (meta_len >> 8) as u8;
            let dd = [
                EventDataDescriptor::from_raw_bytes(&provider.meta, 2), // EVENT_DATA_DESCRIPTOR_TYPE_PROVIDER_METADATA
                EventDataDescriptor::from_raw_bytes(&self.meta, 1), // EVENT_DATA_DESCRIPTOR_TYPE_EVENT_METADATA
                EventDataDescriptor::from_raw_bytes(&self.data, 0), // EVENT_DATA_DESCRIPTOR_TYPE_NONE
            ];
            let ctx = &provider.context;
            result = ctx.write_transfer(&self.descriptor, activity_id, related_id, &dd);
        }
        return result;
    }

    /// Sets the id and version of the event. Default is id = 0, version = 0.
    ///
    /// TraceLogging events are primarily identified by event name, not by id.
    /// Most events use id = 0, version = 0 and therefore do not need to call this
    /// method.
    ///
    /// Events should use id = 0 and version = 0 unless they have a manually-assigned
    /// stable id. If the event has a manually-assigned stable id, it must be a nonzero
    /// value and the version should be incremented each time the event schema changes
    /// (i.e. each time the field names or field types are changed).
    pub fn id_version(&mut self, id: u16, version: u8) -> &mut Self {
        self.descriptor.id = id;
        self.descriptor.version = version;
        return self;
    }

    /// Sets the channel of the event. Default channel = TraceLogging.
    ///
    /// Most events should use channel = TraceLogging and therefore do not need to call
    /// this method.
    pub fn channel(&mut self, channel: Channel) -> &mut Self {
        self.descriptor.channel = channel;
        return self;
    }

    /// Sets the opcode of the event. Default opcode = Info.
    ///
    /// Most events use opcode = Info and therefore do not need to call this method.
    ///
    /// You can use opcode to create an activity (a group of related events):
    ///
    /// 1. Begin the activity by writing an activity-start event with opcode = Start,
    ///    activity_id = the id of the new activity (generated by [Guid::new] or
    ///    [Provider::create_activity_id]), and related_id = the id of the parent
    ///    activity.
    /// 2. As appropriate, write activity-info events with opcode = Info,
    ///    activity_id = the id of the activity, and related_id = None.
    /// 3. End the activity by writing an activity-stop event with opcode = Stop,
    ///    activity_id = the id of the activity, related_id = None, and the same level
    ///    and keyword as were used for the activity-start event.
    pub fn opcode(&mut self, opcode: Opcode) -> &mut Self {
        self.descriptor.opcode = opcode;
        return self;
    }

    /// Sets the task of the event. Default task = 0.
    ///
    /// Most events use task = 0 and therefore do not need to call this method.
    ///
    /// Task is a provider-defined 16-bit value assigned to the event. It can be used
    /// for any purpose, but is typically used as an abstract event id, e.g. while there
    /// might be 2 or 3 distinct events that indicate a different type of network packet
    /// was written, all of them could be assigned the same nonzero "packet written"
    /// task identifier.
    pub fn task(&mut self, task: u16) -> &mut Self {
        self.descriptor.task = task;
        return self;
    }

    /// Adds a CStr16 field (nul-terminated UTF16-LE) from a `&[u16]` value.
    ///
    /// If the string contains characters after a `'\0'`, they will be discarded.
    /// If the string contains no `'\0'` chars, one will be added automatically.
    ///
    /// If out_type is Default, field will format as String.
    /// Other useful out_type values: Xml, Json.
    ///
    /// This is the same as `add_str16` except that the ETW field will be encoded
    /// as a nul-terminated string instead of as a counted string. In most cases
    /// you should prefer `add_str16` and use this method only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_cstr16(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u16]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::CStr16, out_type, field_tag)
            .raw_add_data_cstr(field_value.as_ref());
    }

    /// Adds a CStr16 variable-length array field (nul-terminated UTF16-LE) from an
    /// iterator-of-`&[u16]` value.
    ///
    /// If the string contains characters after a `'\0'`, they will be discarded.
    /// If the string contains no `'\0'` chars, one will be added automatically.
    ///
    /// If out_type is Default, field will format as String.
    /// Other useful out_type values: Xml, Json.
    ///
    /// This is the same as `add_str16_sequence` except that the ETW field will be encoded
    /// as a nul-terminated string instead of as a counted string. In most cases
    /// you should prefer `add_str16_sequence` and use this method only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_cstr16_sequence<T: IntoIterator>(
        &mut self,
        field_name: &str,
        field_values: T,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self
    where
        T::Item: AsRef<[u16]>,
    {
        return self
            .raw_add_meta_vcount(field_name, InType::CStr16, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_cstr(value.as_ref());
            });
    }

    /// Adds a CStr8 field (nul-terminated 8-bit string) from a `&[u8]` value.
    ///
    /// If the string contains characters after a `'\0'`, they will be discarded.
    /// If the string contains no `'\0'` chars, one will be added automatically.
    ///
    /// If out_type is Default, field will format as String (CP1252, not UTF-8).
    /// Other useful out_type values: Xml, Json, Utf8 (all of which decode as UTF-8).
    ///
    /// This is the same as `add_str8` except that the ETW field will be encoded
    /// as a nul-terminated string instead of as a counted string. In most cases
    /// you should prefer `add_str8` and use this method only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_cstr8(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u8]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::CStr8, out_type, field_tag)
            .raw_add_data_cstr(field_value.as_ref());
    }

    /// Adds a CStr8 variable-length array field (nul-terminated 8-bit string) from an
    /// iterator-of-`&[u8]` value.
    ///
    /// If the string contains characters after a `'\0'`, they will be discarded.
    /// If the string contains no `'\0'` chars then one will be added automatically.
    ///
    /// If out_type is Default, field will format as String (CP1252, not UTF-8).
    /// Other useful out_type values: Xml, Json, Utf8 (all of which decode as UTF-8).
    ///
    /// This is the same as `add_str8_sequence` except that the ETW field will be encoded
    /// as a nul-terminated string instead of as a counted string. In most cases
    /// you should prefer `add_str8_sequence` and use this method only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_cstr8_sequence<T: IntoIterator>(
        &mut self,
        field_name: &str,
        field_values: T,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self
    where
        T::Item: AsRef<[u8]>,
    {
        return self
            .raw_add_meta_vcount(field_name, InType::CStr8, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_cstr(value.as_ref());
            });
    }

    /// Adds an I8 field from an `i8` value.
    ///
    /// If out_type is Default, field will format as Signed.
    /// Other useful out_type value: String (formats as CP1252 character).
    pub fn add_i8(
        &mut self,
        field_name: &str,
        field_value: i8,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::I8, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an I8 variable-length array field from an iterator-of-`&i8` value.
    ///
    /// If out_type is Default, field will format as Signed.
    /// Other useful out_type value: String (formats as CP1252 character).
    pub fn add_i8_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a i8>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::I8, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a U8 field from a `u8` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type values: Hex, String (formats as CP1252 char), Boolean.
    pub fn add_u8(
        &mut self,
        field_name: &str,
        field_value: u8,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::U8, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a U8 variable-length array field from an iterator-of-`&u8` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type values: Hex, String (formats as CP1252 char), Boolean.
    pub fn add_u8_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a u8>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::U8, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds an I16 field from an `i16` value.
    ///
    /// If out_type is Default, field will format as Signed.
    pub fn add_i16(
        &mut self,
        field_name: &str,
        field_value: i16,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::I16, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an I16 variable-length array field from an iterator-of-`&i16` value.
    ///
    /// If out_type is Default, field will format as Signed.
    pub fn add_i16_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a i16>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::I16, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a U16 field from a `u16` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type values: Hex, String (formats as UCS-2 char), Port.
    pub fn add_u16(
        &mut self,
        field_name: &str,
        field_value: u16,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::U16, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a U16 variable-length array field from an iterator-of-`&u16` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type values: Hex, String (formats as UCS-2 char), Port.
    pub fn add_u16_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a u16>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::U16, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds an I32 field from an `i32` value.
    ///
    /// If out_type is Default, field will format as Signed.
    /// Other useful out_type value: HResult.
    pub fn add_i32(
        &mut self,
        field_name: &str,
        field_value: i32,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::I32, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an I32 variable-length array field from an iterator-of-`&i32` value.
    ///
    /// If out_type is Default, field will format as Signed.
    /// Other useful out_type value: HResult.
    pub fn add_i32_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a i32>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::I32, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a U32 field from a `u32` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type values: Pid, Tid, IPv4, Win32Error, NtStatus, CodePointer.
    pub fn add_u32(
        &mut self,
        field_name: &str,
        field_value: u32,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::U32, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a U32 variable-length array field from an iterator-of-`&u32` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type values: Pid, Tid, IPv4, Win32Error, NtStatus, CodePointer.
    pub fn add_u32_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a u32>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::U32, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds an I64 field from an `i64` value.
    ///
    /// If out_type is Default, field will format as Signed.
    pub fn add_i64(
        &mut self,
        field_name: &str,
        field_value: i64,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::I64, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an I64 variable-length array field from an iterator-of-`&i64` value.
    ///
    /// If out_type is Default, field will format as Signed.
    pub fn add_i64_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a i64>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::I64, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a U64 field from a `u64` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type value: CodePointer.
    pub fn add_u64(
        &mut self,
        field_name: &str,
        field_value: u64,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::U64, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a U64 variable-length array field from an iterator-of-`&u64` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type value: CodePointer.
    pub fn add_u64_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a u64>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::U64, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds an ISize field from an `isize` value.
    ///
    /// If out_type is Default, field will format as Signed.
    pub fn add_isize(
        &mut self,
        field_name: &str,
        field_value: isize,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::ISize, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an ISize variable-length array field from an iterator-of-`&isize` value.
    ///
    /// If out_type is Default, field will format as Signed.
    pub fn add_isize_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a isize>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::ISize, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a USize field from a `usize` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type value: CodePointer.
    pub fn add_usize(
        &mut self,
        field_name: &str,
        field_value: usize,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::USize, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a USize variable-length array field from an iterator-of-`&usize` value.
    ///
    /// If out_type is Default, field will format as Unsigned.
    /// Other useful out_type value: CodePointer.
    pub fn add_usize_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a usize>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::USize, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds an F32 field from an `f32` value.
    ///
    /// If out_type is Default, field will format as float.
    pub fn add_f32(
        &mut self,
        field_name: &str,
        field_value: f32,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::F32, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an F32 variable-length array field from an iterator-of-`&f32` value.
    ///
    /// If out_type is Default, field will format as float.
    pub fn add_f32_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a f32>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::F32, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds an F64 field from an `f64` value.
    ///
    /// If out_type is Default, field will format as float.
    pub fn add_f64(
        &mut self,
        field_name: &str,
        field_value: f64,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::F64, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds an F64 variable-length array field from an iterator-of-`&f64` value.
    ///
    /// If out_type is Default, field will format as float.
    pub fn add_f64_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a f64>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::F64, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a Bool32 field from an `i32` value.
    ///
    /// If out_type is Default, field will format as Boolean.
    pub fn add_bool32(
        &mut self,
        field_name: &str,
        field_value: i32,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Bool32, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a Bool32 variable-length array field from an iterator-of-`&i32` value.
    ///
    /// If out_type is Default, field will format as Boolean.
    pub fn add_bool32_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a i32>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::Bool32, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a Binary field from a `&[u8]` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: IPv6, SocketAddress, Pkcs7WithTypeInfo.
    ///
    /// This is the same as `add_binaryc` except that it uses an older ETW encoding.
    /// - Older ETW [InType], so decoding works in all versions of Windows.
    /// - Decoded event frequently includes a synthesized "FieldName.Length" field.
    /// - Arrays are not supported.
    ///
    /// Note: There is no `add_binary_sequence` method because the ETW's `Binary` encoding does
    /// not decode correctly with arrays. Array of binary can be created using
    /// `add_binaryc_sequence`, though the resulting event will only decode correctly
    /// if the decoder supports ETW's newer `BinaryC` encoding.
    pub fn add_binary(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u8]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Binary, out_type, field_tag)
            .raw_add_data_counted(field_value.as_ref());
    }

    /// Adds a Guid field from a `&Guid` value.
    ///
    /// GUID is assumed to be encoded in Windows (little-endian) byte order.
    ///
    /// If out_type is Default, field will format as Guid.
    pub fn add_guid(
        &mut self,
        field_name: &str,
        field_value: &Guid,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Guid, out_type, field_tag)
            .raw_add_data_value(field_value);
    }

    /// Adds a Guid variable-length array field from an iterator-of-`&Guid` value.
    ///
    /// GUID is assumed to be encoded in Windows (little-endian) byte order.
    ///
    /// If out_type is Default, field will format as Guid.
    pub fn add_guid_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a Guid>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::Guid, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a FileTime field from an `i64` value.
    ///
    /// If out_type is Default, field will format as DateTime.
    /// Other useful out_type values: DateTimeCultureInsensitive, DateTimeUtc.
    pub fn add_filetime(
        &mut self,
        field_name: &str,
        field_value: i64,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::FileTime, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a FileTime variable-length array field from an iterator-of-`&i64` value.
    ///
    /// If out_type is Default, field will format as DateTime.
    /// Other useful out_type values: DateTimeCultureInsensitive, DateTimeUtc.
    pub fn add_filetime_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a i64>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::FileTime, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a SystemTime field from a `&[u16; 8]` value.
    ///
    /// If out_type is Default, field will format as DateTime.
    /// Other useful out_type values: DateTimeCultureInsensitive, DateTimeUtc.
    pub fn add_systemtime(
        &mut self,
        field_name: &str,
        field_value: &[u16; 8],
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::SystemTime, out_type, field_tag)
            .raw_add_data_value(field_value);
    }

    /// Adds a SystemTime variable-length array field from an iterator-of-`&[u16; 8]` value.
    ///
    /// If out_type is Default, field will format as DateTime.
    /// Other useful out_type values: DateTimeCultureInsensitive, DateTimeUtc.
    pub fn add_systemtime_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a [u16; 8]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::SystemTime, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a Sid field from a `&[u8]` value.
    ///
    /// Sid size is determined by `8 + field_value[1] * 4`.
    ///
    /// If out_type is Default, field will format as SID.
    pub fn add_sid(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u8]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Sid, out_type, field_tag)
            .raw_add_data_sid(field_value.as_ref());
    }

    /// Adds a Sid variable-length array field from an iterator-of-`&[u8]` value.
    ///
    /// Sid size is determined by `8 + field_value[1] * 4`.
    ///
    /// If out_type is Default, field will format as SID.
    pub fn add_sid_sequence<T: IntoIterator>(
        &mut self,
        field_name: &str,
        field_values: T,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self
    where
        T::Item: AsRef<[u8]>,
    {
        return self
            .raw_add_meta_vcount(field_name, InType::Sid, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_sid(value.as_ref());
            });
    }

    /// Adds a Hex32 field from a `u32` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: Win32Error, NtStatus, CodePointer.
    pub fn add_hex32(
        &mut self,
        field_name: &str,
        field_value: u32,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Hex32, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a Hex32 variable-length array field from an iterator-of-`&u32` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: Win32Error, NtStatus, CodePointer.
    pub fn add_hex32_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a u32>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::Hex32, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a Hex64 field from a `u64` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: CodePointer.
    pub fn add_hex64(
        &mut self,
        field_name: &str,
        field_value: u64,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Hex64, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a Hex64 variable-length array field from an iterator-of-`&u64` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: CodePointer.
    pub fn add_hex64_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a u64>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::Hex64, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a HexSize field from a `usize` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: CodePointer.
    pub fn add_hexsize(
        &mut self,
        field_name: &str,
        field_value: usize,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::HexSize, out_type, field_tag)
            .raw_add_data_value(&field_value);
    }

    /// Adds a HexSize variable-length array field from an iterator-of-`&usize` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: CodePointer.
    pub fn add_hexsize_sequence<'a>(
        &mut self,
        field_name: &str,
        field_values: impl IntoIterator<Item = &'a usize>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_vcount(field_name, InType::HexSize, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_value(value);
            });
    }

    /// Adds a Str16 field (counted UTF16-LE) from a `&[u16]` value.
    ///
    /// If out_type is Default, field will format as String.
    /// Other useful out_type values: Xml, Json.
    ///
    /// This is the same as `add_cstr16` except that the ETW field will be encoded
    /// as a counted string instead of as a nul-terminated string. In most cases
    /// you should prefer this method and use `add_cstr16` only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_str16(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u16]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Str16, out_type, field_tag)
            .raw_add_data_counted(field_value.as_ref());
    }

    /// Adds a Str16 variable-length array field (counted UTF16-LE) from an iterator-of-`&[u16]` value.
    ///
    /// If out_type is Default, field will format as String.
    /// Other useful out_type values: Xml, Json.
    ///
    /// This is the same as `add_cstr16_sequence` except that the ETW field will be encoded
    /// as a counted string instead of as a nul-terminated string. In most cases
    /// you should prefer this method and use `add_cstr16_sequence` only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_str16_sequence<T: IntoIterator>(
        &mut self,
        field_name: &str,
        field_values: T,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self
    where
        T::Item: AsRef<[u16]>,
    {
        return self
            .raw_add_meta_vcount(field_name, InType::Str16, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_counted(value.as_ref());
            });
    }

    /// Adds a Str8 field (counted 8-bit string) from a `&[u8]` value.
    ///
    /// If out_type is Default, field will format as String (CP1252, not UTF-8).
    /// Other useful out_type values: Xml, Json, Utf8 (all of which decode as UTF-8).
    ///
    /// This is the same as `add_cstr8` except that the ETW field will be encoded
    /// as a counted string instead of as a nul-terminated string. In most cases
    /// you should prefer this method and use `add_cstr8` only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_str8(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u8]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::Str8, out_type, field_tag)
            .raw_add_data_counted(field_value.as_ref());
    }

    /// Adds a Str8 variable-length array field (counted 8-bit string) from an iterator-of-`&[u8]` value.
    ///
    /// If out_type is Default, field will format as String (CP1252, not UTF-8).
    /// Other useful out_type values: Xml, Json, Utf8 (all of which decode as UTF-8).
    ///
    /// This is the same as `add_cstr8_sequence` except that the ETW field will be encoded
    /// as a counted string instead of as a nul-terminated string. In most cases
    /// you should prefer this method and use `add_cstr8_sequence` only if you specifically
    /// need the nul-terminated encoding.
    pub fn add_str8_sequence<T: IntoIterator>(
        &mut self,
        field_name: &str,
        field_values: T,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self
    where
        T::Item: AsRef<[u8]>,
    {
        return self
            .raw_add_meta_vcount(field_name, InType::Str8, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_counted(value.as_ref());
            });
    }

    /// Adds a BinaryC field from a `&[u8]` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: IPv6, SocketAddress, Pkcs7WithTypeInfo.
    ///
    /// This is the same as add_binary, except that it uses a newer ETW encoding.
    /// - Newer ETW [InType], so decoding might not work with older decoders.
    /// - Decodes without the synthesized "FieldName.Length" field.
    /// - Arrays are supported.
    pub fn add_binaryc(
        &mut self,
        field_name: &str,
        field_value: impl AsRef<[u8]>,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        return self
            .raw_add_meta_scalar(field_name, InType::BinaryC, out_type, field_tag)
            .raw_add_data_counted(field_value.as_ref());
    }

    /// Adds a BinaryC variable-length array field from an iterator-of-`&[u8]` value.
    ///
    /// If out_type is Default, field will format as Hex.
    /// Other useful out_type values: IPv6, SocketAddress, Pkcs7WithTypeInfo.
    ///
    /// This is the same as add_binary, except that it uses a newer ETW encoding.
    /// - Newer ETW [InType], so decoding might not work with older decoders.
    /// - Decodes without the synthesized "FieldName.Length" field.
    /// - Arrays are supported.
    pub fn add_binaryc_sequence<T: IntoIterator>(
        &mut self,
        field_name: &str,
        field_values: T,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self
    where
        T::Item: AsRef<[u8]>,
    {
        return self
            .raw_add_meta_vcount(field_name, InType::BinaryC, out_type, field_tag)
            .raw_add_data_range(field_values, |this, value| {
                this.raw_add_data_counted(value.as_ref());
            });
    }

    /// Adds a Struct field with the specified number of nested fields.
    ///
    /// A struct is a way to logically group a number of fields. To add a struct to
    /// an event, call `builder.add_struct("StructName", field_count)`. Then add
    /// `field_count` more fields and they will be considered to be members of the
    /// struct. The `field_count` parameter must be in the range 0 to 127.
    ///
    /// Structs can nest. Each nested struct and its fields count as 1 field for the
    /// parent struct.
    pub fn add_struct(
        &mut self,
        field_name: &str,
        struct_field_count: u8,
        field_tag: u32,
    ) -> &mut Self {
        debug_assert_eq!(
            struct_field_count & OutType::TypeMask,
            struct_field_count,
            "struct_field_count must be less than 128"
        );
        return self.raw_add_meta(
            field_name,
            InType::Struct.as_int(),
            struct_field_count & OutType::TypeMask,
            field_tag,
        );
    }

    /// *Advanced scenarios:* Directly adds unchecked metadata to the event. Using this
    /// method may result in events that do not decode correctly.
    ///
    /// There are a few things that are supported by TraceLogging that cannot be expressed
    /// by directly calling the add methods, e.g. array-of-struct. If these edge cases are
    /// important, you can use the raw_add_meta and raw_add_data methods to generate events
    /// that would otherwise be impossible. Doing this requires advanced understanding of
    /// the TraceLogging encoding system. If done incorrectly, the resulting events will not
    /// decode properly.
    pub fn raw_add_meta_scalar(
        &mut self,
        field_name: &str,
        in_type: InType,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        debug_assert_eq!(
            in_type.as_int() & InType::FlagMask,
            0,
            "in_type must not include any flags"
        );
        return self.raw_add_meta(field_name, in_type.as_int(), out_type.as_int(), field_tag);
    }

    /// *Advanced scenarios:* Directly adds unchecked metadata to the event. Using this
    /// method may result in events that do not decode correctly.
    ///
    /// There are a few things that are supported by TraceLogging that cannot be expressed
    /// by directly calling the add methods, e.g. array-of-struct. If these edge cases are
    /// important, you can use the raw_add_meta and raw_add_data methods to generate events
    /// that would otherwise be impossible. Doing this requires advanced understanding of
    /// the TraceLogging encoding system. If done incorrectly, the resulting events will not
    /// decode properly.
    pub fn raw_add_meta_vcount(
        &mut self,
        field_name: &str,
        in_type: InType,
        out_type: OutType,
        field_tag: u32,
    ) -> &mut Self {
        debug_assert_eq!(
            in_type.as_int() & InType::FlagMask,
            0,
            "in_type must not include any flags"
        );
        return self.raw_add_meta(
            field_name,
            in_type.as_int() | InType::VariableCountFlag,
            out_type.as_int(),
            field_tag,
        );
    }

    /// *Advanced scenarios:* Directly adds unchecked data to the event. Using this
    /// method may result in events that do not decode correctly.
    ///
    /// There are a few things that are supported by TraceLogging that cannot be expressed
    /// by directly calling the add methods, e.g. array-of-struct. If these edge cases are
    /// important, you can use the raw_add_meta and raw_add_data methods to generate events
    /// that would otherwise be impossible. Doing this requires advanced understanding of
    /// the TraceLogging encoding system. If done incorrectly, the resulting events will not
    /// decode properly.
    pub fn raw_add_data_value<T: Copy>(&mut self, value: &T) -> &mut Self {
        let value_size = size_of::<T>();
        let old_data_size = self.data.len();
        self.data.reserve(value_size);
        unsafe {
            copy_nonoverlapping(
                value as *const T as *const u8,
                self.data.as_mut_ptr().add(old_data_size),
                value_size,
            );
            self.data.set_len(old_data_size + value_size);
        }
        return self;
    }

    /// *Advanced scenarios:* Directly adds unchecked data to the event. Using this
    /// method may result in events that do not decode correctly.
    ///
    /// There are a few things that are supported by TraceLogging that cannot be expressed
    /// by directly calling the add methods, e.g. array-of-struct. If these edge cases are
    /// important, you can use the raw_add_meta and raw_add_data methods to generate events
    /// that would otherwise be impossible. Doing this requires advanced understanding of
    /// the TraceLogging encoding system. If done incorrectly, the resulting events will not
    /// decode properly.
    pub fn raw_add_data_slice<T: Copy>(&mut self, value: &[T]) -> &mut Self {
        let value_size = value.len() * size_of::<T>();
        let old_data_size = self.data.len();
        self.data.reserve(value_size);
        unsafe {
            copy_nonoverlapping(
                value.as_ptr() as *const u8,
                self.data.as_mut_ptr().add(old_data_size),
                value_size,
            );
            self.data.set_len(old_data_size + value_size);
        }
        return self;
    }

    fn raw_add_meta(
        &mut self,
        field_name: &str,
        in_type: u8,
        out_type: u8,
        field_tag: u32,
    ) -> &mut Self {
        debug_assert!(
            !field_name.contains('\0'),
            "field_name must not contain '\\0'"
        );
        debug_assert_eq!(
            field_tag & 0x0FFFFFFF,
            field_tag,
            "field_tag must fit into 28 bits"
        );

        self.meta.reserve(field_name.len() + 7);

        self.meta.extend_from_slice(field_name.as_bytes());
        self.meta.push(0); // nul termination

        if field_tag != 0 {
            self.meta.push(0x80 | in_type);
            self.meta.push(0x80 | out_type);
            self.meta.push(0x80 | (field_tag >> 21) as u8);
            self.meta.push(0x80 | (field_tag >> 14) as u8);
            self.meta.push(0x80 | (field_tag >> 7) as u8);
            self.meta.push((0x7F & field_tag) as u8);
        } else if out_type != 0 {
            self.meta.push(0x80 | in_type);
            self.meta.push(out_type);
        } else {
            self.meta.push(in_type);
        }

        return self;
    }

    fn raw_add_data_sid(&mut self, value: &[u8]) -> &mut Self {
        let sid_length = 8 + 4 * (value[1] as usize);
        debug_assert!(
            sid_length <= value.len(),
            "add_sid(value) requires value.len() >= sid_length(value)"
        );
        return self.raw_add_data_slice(&value[0..sid_length]);
    }

    fn raw_add_data_cstr<T: Copy + Default + Eq>(&mut self, value: &[T]) -> &mut Self {
        let zero = T::default();
        let mut nul_pos = 0;
        while nul_pos != value.len() {
            if value[nul_pos] == zero {
                return self.raw_add_data_slice(&value[0..nul_pos + 1]);
            }
            nul_pos += 1;
        }

        return self.raw_add_data_slice(value).raw_add_data_value(&zero);
    }

    fn raw_add_data_counted<T: Copy>(&mut self, value: &[T]) -> &mut Self {
        let max_len = 65535 / size_of::<T>();
        if value.len() > max_len {
            return self
                .raw_add_data_value(&((max_len as u16) * (size_of::<T>() as u16)))
                .raw_add_data_slice(&value[0..max_len]);
        } else {
            return self
                .raw_add_data_value(&((value.len() as u16) * (size_of::<T>() as u16)))
                .raw_add_data_slice(value);
        }
    }

    fn raw_add_data_range<T: IntoIterator>(
        &mut self,
        field_values: T,
        add_data: impl Fn(&mut Self, T::Item),
    ) -> &mut Self {
        let mut count = 0u16;

        // Reserve space for count.
        let old_data_size = self.data.len();
        self.raw_add_data_value(&count);

        for value in field_values {
            if count == u16::MAX {
                break;
            }
            count += 1;
            add_data(self, value);
        }

        // Save actual value of count.
        self.data[old_data_size] = count as u8;
        self.data[old_data_size + 1] = (count >> 8) as u8;
        return self;
    }
}

impl Default for EventBuilder {
    fn default() -> Self {
        return Self::new();
    }
}