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
|
<!DOCTYPE html>
<html lang="en"><head>
<meta charset="utf-8"/>
<title>toml namespace | toml++ TOML for C++</title>
<link href="favicon.ico" rel="icon" type="image/vnd.microsoft.icon"/>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<meta content="#22272e" name="theme-color"/>
<link href="poxy/poxy.css" referrerpolicy="no-referrer" rel="stylesheet"/>
<script src="poxy/poxy.js"></script>
<script>initialize_theme("dark");</script>
<meta content="toml++" name="twitter:title"/>
<meta content="toml++" property="og:title"/>
<meta content="toml++" itemprop="name"/>
<meta content="Mark Gillard" name="author"/>
<meta content="Mark Gillard" property="article:author"/>
<meta content="TOML for C++" name="description"/>
<meta content="TOML for C++" name="twitter:description"/>
<meta content="TOML for C++" property="og:description"/>
<meta content="TOML for C++" itemprop="description"/>
<meta content="telephone=no" name="format-detection"/>
<meta content="Poxy v0.20.1" name="generator"/>
<meta content="strict-origin-when-cross-origin" name="referrer"/>
<meta content="gbtcNgKlNiPSMKkYMw4zWFVWGPH_oU93m9n_-nb4qK8" name="google-site-verification"/>
</head>
<body class="poxy-has-toc">
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a class="m-col-t-8 m-col-m-none m-left-m" href="index.html" id="m-navbar-brand"><svg class="poxy-injected-svg" id="poxy-injected-svg-0" version="1.1" viewBox="0 0 306 306" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><polygon fill="currentColor" points="0 0 0 306 67.79 306 67.79 273.09 35.1 273.09 35.1 33.62 67.79 33.62 67.79 0 0 0"></polygon><polygon fill="currentColor" points="237.62 0 237.62 33.62 270.3 33.62 270.3 273.09 237.62 273.09 237.62 306 306 306 306 0 237.62 0"></polygon><polygon fill="currentColor" points="127.3 247.43 127.3 109.37 172.72 109.37 172.72 77.69 48.41 77.69 48.41 109.37 94.43 109.37 94.43 247.43 127.3 247.43"></polygon><polygon fill="currentColor" points="256.69 163.46 241.45 163.46 241.45 148.22 222.33 148.22 222.33 163.46 207.09 163.46 207.09 182.58 222.33 182.58 222.33 197.82 241.45 197.82 241.45 182.58 256.69 182.58 256.69 163.46"></polygon><polygon fill="currentColor" points="192.74 163.46 177.5 163.46 177.5 148.22 158.38 148.22 158.38 163.46 143.14 163.46 143.14 182.58 158.38 182.58 158.38 197.82 177.5 197.82 177.5 182.58 192.74 182.58 192.74 163.46"></polygon></svg>toml++ <span class="m-thin">TOML for C++</span></a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z" id="m-doc-search-icon-path"></path>
</svg></a>
<a href="#navigation" id="m-navbar-show" title="Show navigation"></a>
<a href="#" id="m-navbar-hide" title="Hide navigation"></a>
</div>
<div class="m-col-t-12 m-show-m m-col-m-none m-right-m" id="m-navbar-collapse">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li class="poxy-navbar-version-selector"><a href="namespacetoml.html">Version: HEAD</a><ol><li><a href="namespacetoml.html">HEAD</a></li></ol></li>
<li><a class="poxy-icon twitter poxy-external" href="https://twitter.com/marzer8789" target="_blank" title="Twitter"><svg id="poxy-icon-twitter" version="1.1" viewBox="0 0 50 50" xmlns="http://www.w3.org/2000/svg"><path d="M 50.0625 10.4375 C 48.214844 11.257813 46.234375 11.808594 44.152344 12.058594 C 46.277344 10.785156 47.910156 8.769531 48.675781 6.371094 C 46.691406 7.546875 44.484375 8.402344 42.144531 8.863281 C 40.269531 6.863281 37.597656 5.617188 34.640625 5.617188 C 28.960938 5.617188 24.355469 10.21875 24.355469 15.898438 C 24.355469 16.703125 24.449219 17.488281 24.625 18.242188 C 16.078125 17.8125 8.503906 13.71875 3.429688 7.496094 C 2.542969 9.019531 2.039063 10.785156 2.039063 12.667969 C 2.039063 16.234375 3.851563 19.382813 6.613281 21.230469 C 4.925781 21.175781 3.339844 20.710938 1.953125 19.941406 C 1.953125 19.984375 1.953125 20.027344 1.953125 20.070313 C 1.953125 25.054688 5.5 29.207031 10.199219 30.15625 C 9.339844 30.390625 8.429688 30.515625 7.492188 30.515625 C 6.828125 30.515625 6.183594 30.453125 5.554688 30.328125 C 6.867188 34.410156 10.664063 37.390625 15.160156 37.472656 C 11.644531 40.230469 7.210938 41.871094 2.390625 41.871094 C 1.558594 41.871094 0.742188 41.824219 -0.0585938 41.726563 C 4.488281 44.648438 9.894531 46.347656 15.703125 46.347656 C 34.617188 46.347656 44.960938 30.679688 44.960938 17.09375 C 44.960938 16.648438 44.949219 16.199219 44.933594 15.761719 C 46.941406 14.3125 48.683594 12.5 50.0625 10.4375 Z" fill="currentColor"></path></svg></a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="5">
<li><a class="poxy-icon repo github poxy-external" href="https://github.com/marzer/tomlplusplus" target="_blank" title="View on GitHub"><svg id="poxy-icon-repo" version="1.1" viewBox="0 0 50 50" xmlns="http://www.w3.org/2000/svg"><path d="M25,1.23a24.37,24.37,0,0,0-7.7,47.5C18.51,49,19,48.2,19,47.56s0-2.12,0-4.15c-6.78,1.47-8.21-3.27-8.21-3.27C9.61,37.33,8,36.58,8,36.58c-2.21-1.51.17-1.48.17-1.48a5.12,5.12,0,0,1,3.73,2.51c2.17,3.72,5.7,2.65,7.09,2a5.25,5.25,0,0,1,1.55-3.26c-5.41-.61-11.1-2.7-11.1-12A9.41,9.41,0,0,1,12,17.79a8.75,8.75,0,0,1,.24-6.45s2-.66,6.7,2.49a23.1,23.1,0,0,1,12.2,0c4.66-3.15,6.7-2.49,6.7-2.49A8.75,8.75,0,0,1,38,17.79a9.41,9.41,0,0,1,2.51,6.54c0,9.36-5.7,11.42-11.13,12a5.83,5.83,0,0,1,1.65,4.51c0,3.26,0,5.89,0,6.69,0,.65.44,1.41,1.68,1.17A24.38,24.38,0,0,0,25,1.23Z" fill="currentColor"></path></svg></a></li>
<li><a class="poxy-icon sponsor poxy-external" href="https://github.com/sponsors/marzer" target="_blank" title="Become a sponsor"><svg id="poxy-icon-sponsor" version="1.1" viewBox="0 0 66.911 66.911" xmlns="http://www.w3.org/2000/svg"><path d="M66.911,22.831c0-10.563-8.558-19.122-19.118-19.122c-5.658,0-10.721,2.473-14.223,6.377 c-0.037,0.043-0.076,0.085-0.113,0.128c-3.5-3.98-8.618-6.505-14.334-6.505C8.561,3.709,0.005,12.268,0,22.831 c0,5.834,2.629,11.059,6.758,14.565H6.751l27.104,25.806l26.308-25.806h-0.012C64.279,33.89,66.911,28.669,66.911,22.831z" fill="currentColor"></path></svg></a></li>
<li><a class="poxy-icon theme" href="javascript:void(null);" id="poxy-theme-switch" onclick="toggle_theme(); return false;" role="button" title="Toggle dark and light themes"><svg id="poxy-theme-switch-img" version="1.1" viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><circle cx="185.6708" cy="183.8122" fill="currentColor" r="65.625"></circle><path d="M185.6708,87.5622a13.1256,13.1256,0,0,0,13.125-13.125V52.5622a13.125,13.125,0,1,0-26.25,0v21.875A13.1257,13.1257,0,0,0,185.6708,87.5622Z" fill="currentColor"></path><path d="M99.051,115.7519a13.1236,13.1236,0,1,0,18.56-18.56L102.1442,81.726a13.1236,13.1236,0,0,0-18.5595,18.56Z" fill="currentColor"></path><path d="M89.4208,183.8122a13.1257,13.1257,0,0,0-13.125-13.125H54.4208a13.125,13.125,0,0,0,0,26.25h21.875A13.1256,13.1256,0,0,0,89.4208,183.8122Z" fill="currentColor"></path><path d="M99.051,251.8725,83.5847,267.3431a13.1236,13.1236,0,1,0,18.56,18.56l15.4663-15.4706a13.1236,13.1236,0,1,0-18.5595-18.56Z" fill="currentColor"></path><path d="M185.6708,280.0622a13.1258,13.1258,0,0,0-13.125,13.125v21.875a13.125,13.125,0,0,0,26.25,0v-21.875A13.1257,13.1257,0,0,0,185.6708,280.0622Z" fill="currentColor"></path><path d="M272.2907,251.8725a13.1236,13.1236,0,1,0-18.56,18.56l15.4663,15.4706a13.1236,13.1236,0,1,0,18.56-18.56Z" fill="currentColor"></path><path d="M330.0458,183.8122a13.1257,13.1257,0,0,0-13.125-13.125h-21.875a13.125,13.125,0,0,0,0,26.25h21.875A13.1256,13.1256,0,0,0,330.0458,183.8122Z" fill="currentColor"></path><path d="M263.0109,119.5971a13.0824,13.0824,0,0,0,9.28-3.8452l15.4663-15.4663a13.1236,13.1236,0,1,0-18.56-18.56L253.7312,97.1923a13.125,13.125,0,0,0,9.28,22.4048Z" fill="currentColor"></path><path d="M456.9379,401.6714a63.97,63.97,0,0,1-14.9963,7.2055c-19.6448,6.5283-41.8787,2.9566-58.1439-9.8523a68.9311,68.9311,0,0,1-10.835-10.8339c-12.8088-16.2663-16.3806-38.5-9.8523-58.1471a63.8444,63.8444,0,0,1,7.2077-14.9931,8.8036,8.8036,0,0,0-10.1172-13.3034,87.5188,87.5188,0,1,0,110.0372,110.04A8.8,8.8,0,0,0,456.9379,401.6714Z" fill="currentColor"></path></svg></a></li>
<li class="m-show-m"><a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path"></use>
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
toml <span class="m-thin">namespace</span>
</h1>
<p>The root namespace for all toml++ functions and types.</p>
<nav class="m-block m-default poxy-toc" id="poxy-toc">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#namespaces">Namespaces</a></li>
<li><a href="#nested-classes">Classes</a></li>
<li><a href="#enum-members">Enums</a></li>
<li><a href="#typedef-members">Typedefs</a></li>
<li><a href="#func-members">Functions</a></li>
<li><a href="#var-members">Variables</a></li>
</ul>
</li>
</ul>
</nav>
<section id="namespaces">
<h2><a href="#namespaces">Namespaces</a></h2>
<dl class="m-doc">
<dt>namespace <a class="m-doc" href="namespacetoml_1_1literals.html">literals</a> <span class="m-label m-flat m-info">inline</span></dt>
<dd>Convenience literal operators for working with toml++.</dd>
</dl>
</section>
<section id="nested-classes">
<h2><a href="#nested-classes">Classes</a></h2>
<dl class="m-doc">
<dt>
class <a class="m-doc" href="classtoml_1_1array.html">array</a>
</dt>
<dd>A TOML array.</dd>
<dt>
struct <a class="m-doc" href="structtoml_1_1date.html">date</a>
</dt>
<dd>A local date.</dd>
<dt>
struct <a class="m-doc" href="structtoml_1_1date__time.html">date_time</a>
</dt>
<dd>A <a class="m-doc poxy-injected" href="structtoml_1_1date__time.html">date-time</a>.</dd>
<dt>
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
struct <a class="m-doc" href="structtoml_1_1inserter.html">inserter</a>
</dt>
<dd>Helper class for suppressing move-construction in single-argument array constructors.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1json__formatter.html">json_formatter</a>
</dt>
<dd>A wrapper for printing TOML objects out to a stream as formatted JSON.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1key.html">key</a>
</dt>
<dd>A key parsed from a TOML document.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1node.html">node</a>
</dt>
<dd>A TOML node.</dd>
<dt>
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename ViewedType</span></span>></div>
class <a class="m-doc" href="classtoml_1_1node__view.html">node_view</a>
</dt>
<dd>A view of a node.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1parse__error.html">parse_error</a>
</dt>
<dd>An error generated when parsing fails.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1parse__result.html">parse_result</a>
</dt>
<dd>The result of a parsing operation.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1path.html">path</a>
</dt>
<dd>A TOML path.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1path__component.html">path_component</a>
</dt>
<dd>Represents a single component of a complete 'TOML-path': either a key or an array index.</dd>
<dt>
struct <a class="m-doc" href="structtoml_1_1source__position.html">source_position</a>
</dt>
<dd>A source document line-and-column pair.</dd>
<dt>
struct <a class="m-doc" href="structtoml_1_1source__region.html">source_region</a>
</dt>
<dd>A source document region.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1table.html">table</a>
</dt>
<dd>A TOML table.</dd>
<dt>
struct <a class="m-doc" href="structtoml_1_1time.html">time</a>
</dt>
<dd>A local time-of-day.</dd>
<dt>
struct <a class="m-doc" href="structtoml_1_1time__offset.html">time_offset</a>
</dt>
<dd>A timezone offset.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1toml__formatter.html">toml_formatter</a>
</dt>
<dd>A wrapper for printing TOML objects out to a stream as formatted TOML.</dd>
<dt>
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename ValueType</span></span>></div>
class <a class="m-doc" href="classtoml_1_1value.html">value</a>
</dt>
<dd>A TOML value.</dd>
<dt>
class <a class="m-doc" href="classtoml_1_1yaml__formatter.html">yaml_formatter</a>
</dt>
<dd>A wrapper for printing TOML objects out to a stream as formatted YAML.</dd>
</dl>
</section>
<section id="enum-members">
<h2><a href="#enum-members">Enums</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">enum class <a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6a">format_flags</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint64_t</a> { </span><span class="m-doc-wrap"><a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa334c4a4c42fdb79d7ebc3e73b517e6f8">none</a>,
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa6e569050aafc6eca4c0c5dfab35fd25a">quote_dates_and_times</a> = (1ull << 0),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aaebc5b9f8f77d6df3c806339479f46098">quote_infinities_and_nans</a> = (1ull << 1),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa328473763ff1ab919ce0b01d66ad3bf6">allow_literal_strings</a> = (1ull << 2),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aad9467c39215be4189dc8395a830f9051">allow_multi_line_strings</a> = (1ull << 3),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa85cd74c0ce79c211961b6db05587778c">allow_real_tabs_in_strings</a> = (1ull << 4),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aab8d4fc7b15531737d6d22536c5f3881c">allow_unicode_strings</a> = (1ull << 5),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aae8dbe11e331b30941899ce81fd2fee41">allow_binary_integers</a> = (1ull << 6),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa3d184bcd6e8f69ebc29b148945f23d4e">allow_octal_integers</a> = (1ull << 7),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa41e4d7c47742f8f5b60161cc594b169b">allow_hexadecimal_integers</a> = (1ull << 8),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa4ccbf147a4e194e7d2ae2b242e1eeceb">indent_sub_tables</a> = (1ull << 9),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa8bf21ed1736197d191a147317c7ea95b">indent_array_elements</a> = (1ull << 10),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa449072e30b43d04b744f22522a880818">indentation</a> = indent_sub_tables | indent_array_elements,
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa2023489f273b06937dd37c25b2cf2078">relaxed_float_precision</a> = (1ull << 11),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa4c8bfd397c155cf5841842cdbb556edd">terse_key_value_pairs</a> = (1ull << 12),
<a class="m-doc" href="#a2102aa80bc57783d96180f36e1f64f6aa78b9ffac2669c1419aeb8dcc845a70bb">force_multiline_arrays</a> = (1ull << 13) }</span>
</dt>
<dd>Format flags for modifying how TOML data is printed to streams.</dd>
<dt>
<span class="m-doc-wrap-bumper">enum class <a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48d">node_type</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint8_t</a> { </span><span class="m-doc-wrap"><a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48da334c4a4c42fdb79d7ebc3e73b517e6f8">none</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48daaab9e1de16f38176f86d7a92ba337a8d">table</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48daf1f713c9e000f5d3f280adbd124df4f5">array</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48dab45cffe084dd3d20d928bee85e7b0f21">string</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48da157db7df530023575515d366c9b672e8">integer</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48da387f7c620a256fdffcec74c1e7181a2a">floating_point</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48da84e2c64f38f78ba3ea5c905ab5a2da27">boolean</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48da5fc732311905cb27e82d67f4f6511f7f">date</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48da07cc694b9b3fc636710fa08b6922c42b">time</a>,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48dad611c46f8e65d9e049afe165de18c264">date_time</a> }</span>
</dt>
<dd>TOML node type identifiers.</dd>
<dt id="a05daf3902d4363b06fb467a3292c0bc5">
<span class="m-doc-wrap-bumper">enum class <a class="m-doc-self" href="#a05daf3902d4363b06fb467a3292c0bc5">path_component_type</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint8_t</a> { </span><span class="m-doc-wrap"><a class="m-doc-self" href="#a05daf3902d4363b06fb467a3292c0bc5">key</a> = 0x1,
<a class="m-doc-self" href="#a05daf3902d4363b06fb467a3292c0bc5">array_index</a> = 0x2 }</span>
</dt>
<dd>Indicates type of <a class="m-doc poxy-injected" href="classtoml_1_1path__component.html">path component</a>, either a key, an index in an array, or invalid.</dd>
<dt>
<span class="m-doc-wrap-bumper">enum class <a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5">value_flags</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint16_t</a> { </span><span class="m-doc-wrap"><a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5a334c4a4c42fdb79d7ebc3e73b517e6f8">none</a>,
<a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5a3d21a9285de175ffffc99cfa13df21df">format_as_binary</a> = 1,
<a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5adfc26763754dabbdf97d3c8833a2e8ba">format_as_octal</a> = 2,
<a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5a4dd3fec464b7da02debfbc0bd4725c29">format_as_hexadecimal</a> = 3 }</span>
</dt>
<dd>Metadata associated with TOML values.</dd>
</dl>
</section>
<section id="typedef-members">
<h2><a href="#typedef-members">Typedefs</a></h2>
<dl class="m-doc">
<dt id="a29f7024613d87f4c439bcfe069a4a3e6">
using <a class="m-doc-self" href="#a29f7024613d87f4c439bcfe069a4a3e6">array_iterator</a> = <code class="m-note m-dim poxy-impl">/* ... */</code>
</dt>
<dd>A <a class="m-doc poxy-injected poxy-external poxy-cppreference poxy-named-requirement" href="https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator" target="_blank">RandomAccessIterator</a> for iterating over elements in a <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</dd>
<dt id="af895b4da4a93355537c7fce73b8a38ab">
using <a class="m-doc-self" href="#af895b4da4a93355537c7fce73b8a38ab">const_array_iterator</a> = <code class="m-note m-dim poxy-impl">/* ... */</code>
</dt>
<dd>A <a class="m-doc poxy-injected poxy-external poxy-cppreference poxy-named-requirement" href="https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator" target="_blank">RandomAccessIterator</a> for iterating over const elements in a <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</dd>
<dt id="aebe170823fa068b873aa4c775d597993">
using <a class="m-doc-self" href="#aebe170823fa068b873aa4c775d597993">const_table_iterator</a> = <code class="m-note m-dim poxy-impl">/* ... */</code>
</dt>
<dd>A <a class="m-doc poxy-injected poxy-external poxy-cppreference poxy-named-requirement" href="https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator" target="_blank">BidirectionalIterator</a> for iterating over const key-value pairs in a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>.</dd>
<dt>
using <a class="m-doc" href="#a2b87b5d257f54773683328031f453e76">default_formatter</a> = <a class="m-doc" href="classtoml_1_1toml__formatter.html">toml_<wbr/>formatter</a>
</dt>
<dd>The 'default' formatter used by TOML objects when they are printed to a stream.</dd>
<dt>
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
using <a class="m-doc" href="#a98d783a1c89ce747982c2d24a5329882">inserted_type_of</a> = <code class="m-note m-dim poxy-impl">/* ... */</code>
</dt>
<dd>Metafunction for determining which node type would be constructed if an object of this type was inserted into a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a> or <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</dd>
<dt>
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
using <a class="m-doc" href="#af34a9fb3305e419784104609e6bbb7ac">optional</a> = <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/utility/optional.html" target="_blank">std::<wbr/>optional</a><T>
</dt>
<dd>The 'optional' type used throughout the library.</dd>
<dt id="afb852fa22a8b3ea9d200d645b9d5c308">
using <a class="m-doc-self" href="#afb852fa22a8b3ea9d200d645b9d5c308">source_index</a> = <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint32_t</a>
</dt>
<dd>The integer type used to tally line numbers and columns.</dd>
<dt id="ac6cf446b480546ae1f71f5b86442368d">
using <a class="m-doc-self" href="#ac6cf446b480546ae1f71f5b86442368d">source_path_ptr</a> = <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" target="_blank">std::<wbr/>shared_ptr</a><const <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>>
</dt>
<dd>A pointer to a shared string resource containing a source path.</dd>
<dt id="aaed1da38e7ed361e105fae086cf7b0c1">
using <a class="m-doc-self" href="#aaed1da38e7ed361e105fae086cf7b0c1">table_iterator</a> = <code class="m-note m-dim poxy-impl">/* ... */</code>
</dt>
<dd>A <a class="m-doc poxy-injected poxy-external poxy-cppreference poxy-named-requirement" href="https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator" target="_blank">BidirectionalIterator</a> for iterating over key-value pairs in a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>.</dd>
</dl>
</section>
<section id="func-members">
<h2><a href="#func-members">Functions</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a3024ba7b40cb19fa565b5ac80ac72c2d">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> path) → <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Returns a view of the node matching a fully-qualified "TOML path".</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#aad864d99bf53e2b53a8fee28c2299d43">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> path) → <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Returns a const view of the node matching a fully-qualified "TOML path".</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#af388e5adca27fada36874c8b9bc795ee">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> path) → <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>></span>
</dt>
<dd>Returns a view of the node matching a fully-qualified "TOML path".</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a42b45f76519136534c835cc210b5220f">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> path) → <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>></span>
</dt>
<dd>Returns a const view of the node matching a fully-qualified "TOML path".</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a402a1973caa5c848ca494cac31d1085d">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) → <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Returns a view of the node matching a fully-qualified "TOML path".</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a3655200a65b1974b8bd13c1a4b5e45c1">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) → <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Returns a const view of the node matching a fully-qualified "TOML path".</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a7a137fbfb3f257680292c20bce18a55d">get_line</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc" href="#afb852fa22a8b3ea9d200d645b9d5c308">source_<wbr/>index</a> line_num) → <a class="m-doc" href="#af34a9fb3305e419784104609e6bbb7ac">optional</a><<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a>> <span class="m-label m-flat m-primary">constexpr</span> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Returns the line at the specified line number, from the specified document.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="namespacetoml_1_1literals.html#a401530e560c2dc540729af01e10b2a74">operator""_toml</a>(</span><span class="m-doc-wrap">const char* str,
<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> len) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses TOML data from a string literal.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="namespacetoml_1_1literals.html#abb2307d66538d0d43dd074040f83224c">operator""_toml</a>(</span><span class="m-doc-wrap">const <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a>* str,
<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> len) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses TOML data from a UTF-8 string literal.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="namespacetoml_1_1literals.html#ad406c84d960dd5bda91564f738f67d47">operator""_tpath</a>(</span><span class="m-doc-wrap">const char* str,
<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> len) → <a class="m-doc" href="classtoml_1_1path.html">path</a></span>
</dt>
<dd>Parses a TOML path from a string literal.</dd>
<dt>
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename Char</span></span>></div>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a8a37f07ea9c0a841be1352143b3cbc52">operator<<</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>basic_ostream</a><Char>& lhs,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> rhs) → <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>basic_ostream</a><Char>&</span>
</dt>
<dd>Pretty-prints the value of a node_type to a stream.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ada8654fb4ceef15c20fc1d5e0cc734dd">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> source_path = {}) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a string view.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a20fa3e08d72759083fb17c772a357043">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>&& source_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a string view.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ae9ee4300ddfbd72b7237283ab8d97618">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> source_path = {}) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a> string view.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a02a2724564149ad8439c0457357308b8">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>&& source_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a> string view.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a01565f26a7982d162949bac3b554a334">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> source_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a string view.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ac7767943620762c22b6341dc6682cc2d">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" target="_blank">std::<wbr/>istream</a>& doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> source_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a stream.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a38852451309f406db281f17334ea8dfe">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> source_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a> string view.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a2ee84ffccded737ab40afcb8122d8277">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" target="_blank">std::<wbr/>istream</a>& doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> source_path = {}) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a stream.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a8079e71bd86722701ca91828c6709305">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" target="_blank">std::<wbr/>istream</a>& doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>&& source_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a stream.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a8dbc58dad43c3b66f4476a7131f5741a">parse_file</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> file_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a file.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#acdbabd4b771d221fe98b0053d848d69d">parse_file</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> file_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a file.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ad425af491341206589ca6acc37c3b19e">parse_file</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> file_path) → <a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a></span>
</dt>
<dd>Parses a TOML document from a file.</dd>
</dl>
</section>
<section id="var-members">
<h2><a href="#var-members">Variables</a></h2>
<dl class="m-doc">
<dt id="a2251b703f3ec4d1a3036c82ead3d69cc">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a2251b703f3ec4d1a3036c82ead3d69cc">is_array</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</dd>
<dt id="a8e79820651cc9a835082cf9abd47d885">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a8e79820651cc9a835082cf9abd47d885">is_boolean</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a bool or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><bool>.</dd>
<dt id="a7f8764060ca7dccb7e829f67d82c0485">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a7f8764060ca7dccb7e829f67d82c0485">is_chronological</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type satisfies any of <a class="m-doc" href="#a3c5daa4563e3aff2b5e6460aa97d28df">toml::<wbr/>is_date</a>, <a class="m-doc" href="#a87aee32768a32bb838150421e4e3cf97">toml::<wbr/>is_time</a> or <a class="m-doc" href="#a3285caf012789a607851026f9827a33d">toml::<wbr/>is_date_time</a>.</dd>
<dt id="ad6c6e1677e1cc564d40efa89af2514a2">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#ad6c6e1677e1cc564d40efa89af2514a2">is_container</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type satisfies either <a class="m-doc" href="#ad11c8c8a8286d6931e40658679aa7ddb">toml::<wbr/>is_table</a> or <a class="m-doc" href="#a2251b703f3ec4d1a3036c82ead3d69cc">toml::<wbr/>is_array</a>.</dd>
<dt id="a3c5daa4563e3aff2b5e6460aa97d28df">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a3c5daa4563e3aff2b5e6460aa97d28df">is_date</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="structtoml_1_1date.html">toml::<wbr/>date</a> or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><date>.</dd>
<dt id="a3285caf012789a607851026f9827a33d">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a3285caf012789a607851026f9827a33d">is_date_time</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="structtoml_1_1date__time.html">toml::<wbr/>date_time</a> or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><<a class="m-doc poxy-injected" href="structtoml_1_1date__time.html">date_time</a>>.</dd>
<dt id="a1aaaa0e264cdd4f43518571f2f61ac36">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a1aaaa0e264cdd4f43518571f2f61ac36">is_floating_point</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a double or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><double>.</dd>
<dt id="a513bdc4a19071f0be70e92bb6cb1a1a3">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a513bdc4a19071f0be70e92bb6cb1a1a3">is_integer</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a> or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a>>.</dd>
<dt id="a7b8ef907d9629d139a30d874b345b195">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a7b8ef907d9629d139a30d874b345b195">is_key</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="classtoml_1_1key.html">toml::<wbr/>key</a>.</dd>
<dt id="a052fafde71907ef3a8590ef7ec2455d8">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a052fafde71907ef3a8590ef7ec2455d8">is_key_or_convertible</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="classtoml_1_1key.html">toml::<wbr/>key</a>, or is implicitly or explicitly convertible to one.</dd>
<dt id="a4e4126f63ba560963de095cd9bee0704">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a4e4126f63ba560963de095cd9bee0704">is_node</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a> (or one of its subclasses).</dd>
<dt id="ab5b06dac8c1e0de9e06411917e10b618">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#ab5b06dac8c1e0de9e06411917e10b618">is_node_view</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>.</dd>
<dt id="a64ce7ed6974d2b17823565bc67c40873">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a64ce7ed6974d2b17823565bc67c40873">is_number</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type satisfies either <a class="m-doc" href="#a513bdc4a19071f0be70e92bb6cb1a1a3">toml::<wbr/>is_integer</a> or <a class="m-doc" href="#a1aaaa0e264cdd4f43518571f2f61ac36">toml::<wbr/>is_floating_point</a>.</dd>
<dt id="aea14621807afe92a840d82c7139cde07">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#aea14621807afe92a840d82c7139cde07">is_string</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a> or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a>>.</dd>
<dt id="ad11c8c8a8286d6931e40658679aa7ddb">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#ad11c8c8a8286d6931e40658679aa7ddb">is_table</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>.</dd>
<dt id="a87aee32768a32bb838150421e4e3cf97">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a87aee32768a32bb838150421e4e3cf97">is_time</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, a <a class="m-doc" href="structtoml_1_1time.html">toml::<wbr/>time</a> or <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><time>.</dd>
<dt id="a0d9cd265e448130b95305ccd68d2f508">
<div class="m-doc-template">template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>></div>
bool <a class="m-doc-self" href="#a0d9cd265e448130b95305ccd68d2f508">is_value</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Metafunction for determining if a type is, or is a reference to, any of the toml value types. Excludes tables and arrays.</dd>
<dt id="a32f700b152e15c357801e905d626a4fb">
<a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> <a class="m-doc-self" href="#a32f700b152e15c357801e905d626a4fb">preserve_source_value_flags</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Special <a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5">toml::<wbr/>value_flags</a> constant used for array + table insert functions to specify that any value nodes being copied should not have their flags property overridden by the inserting function's <code>flags</code> argument.</dd>
</dl>
</section>
<section>
<h2>Enum documentation</h2>
<section class="m-doc-details" id="a2102aa80bc57783d96180f36e1f64f6a"><div>
<h3>
enum class <span class="m-doc-details-prefix">toml::<wbr/></span><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6a">format_flags</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint64_t</a>
</h3>
<p>Format flags for modifying how TOML data is printed to streams.</p>
<aside class="m-note m-info"><h4>Note</h4><p>Formatters may disregard/override any of these flags according to the requirements of their output target (e.g. <a class="m-doc" href="classtoml_1_1json__formatter.html">toml::<wbr/>json_formatter</a> will always apply quotes to dates and times).</p></aside>
<table class="m-table m-fullwidth m-flat m-doc">
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
<tbody>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa334c4a4c42fdb79d7ebc3e73b517e6f8" id="a2102aa80bc57783d96180f36e1f64f6aa334c4a4c42fdb79d7ebc3e73b517e6f8">none</a></td>
<td>
<p>None.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa6e569050aafc6eca4c0c5dfab35fd25a" id="a2102aa80bc57783d96180f36e1f64f6aa6e569050aafc6eca4c0c5dfab35fd25a">quote_dates_and_times</a></td>
<td>
<p>Dates and times will be emitted as quoted strings.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aaebc5b9f8f77d6df3c806339479f46098" id="a2102aa80bc57783d96180f36e1f64f6aaebc5b9f8f77d6df3c806339479f46098">quote_infinities_and_nans</a></td>
<td>
<p>Infinities and NaNs will be emitted as quoted strings.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa328473763ff1ab919ce0b01d66ad3bf6" id="a2102aa80bc57783d96180f36e1f64f6aa328473763ff1ab919ce0b01d66ad3bf6">allow_literal_strings</a></td>
<td>
<p>Strings will be emitted as single-quoted literal strings where possible.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aad9467c39215be4189dc8395a830f9051" id="a2102aa80bc57783d96180f36e1f64f6aad9467c39215be4189dc8395a830f9051">allow_multi_line_strings</a></td>
<td>
<p>Strings containing newlines will be emitted as triple-quoted 'multi-line' strings where possible.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa85cd74c0ce79c211961b6db05587778c" id="a2102aa80bc57783d96180f36e1f64f6aa85cd74c0ce79c211961b6db05587778c">allow_real_tabs_in_strings</a></td>
<td>
<p>Allow real tab characters in string literals (as opposed to the escaped form <code>\t</code>).</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aab8d4fc7b15531737d6d22536c5f3881c" id="a2102aa80bc57783d96180f36e1f64f6aab8d4fc7b15531737d6d22536c5f3881c">allow_unicode_strings</a></td>
<td>
<p>Allow non-ASCII characters in strings (as opposed to their escaped form, e.g. <code>\u00DA</code>).</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aae8dbe11e331b30941899ce81fd2fee41" id="a2102aa80bc57783d96180f36e1f64f6aae8dbe11e331b30941899ce81fd2fee41">allow_binary_integers</a></td>
<td>
<p>Allow integers with <a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5a3d21a9285de175ffffc99cfa13df21df">value_flags::<wbr/>format_as_binary</a> to be emitted as binary.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa3d184bcd6e8f69ebc29b148945f23d4e" id="a2102aa80bc57783d96180f36e1f64f6aa3d184bcd6e8f69ebc29b148945f23d4e">allow_octal_integers</a></td>
<td>
<p>Allow integers with <a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5adfc26763754dabbdf97d3c8833a2e8ba">value_flags::<wbr/>format_as_octal</a> to be emitted as octal.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa41e4d7c47742f8f5b60161cc594b169b" id="a2102aa80bc57783d96180f36e1f64f6aa41e4d7c47742f8f5b60161cc594b169b">allow_hexadecimal_integers</a></td>
<td>
<p>Allow integers with <a class="m-doc" href="#a73eba6a34e7c7c4a4d311100800e1bb5a4dd3fec464b7da02debfbc0bd4725c29">value_flags::<wbr/>format_as_hexadecimal</a> to be emitted as hexadecimal.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa4ccbf147a4e194e7d2ae2b242e1eeceb" id="a2102aa80bc57783d96180f36e1f64f6aa4ccbf147a4e194e7d2ae2b242e1eeceb">indent_sub_tables</a></td>
<td>
<p>Apply indentation to tables nested within other tables/arrays.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa8bf21ed1736197d191a147317c7ea95b" id="a2102aa80bc57783d96180f36e1f64f6aa8bf21ed1736197d191a147317c7ea95b">indent_array_elements</a></td>
<td>
<p>Apply indentation to array elements when the array is forced to wrap over multiple lines.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa449072e30b43d04b744f22522a880818" id="a2102aa80bc57783d96180f36e1f64f6aa449072e30b43d04b744f22522a880818">indentation</a></td>
<td>
<p>Combination mask of all indentation-enabling flags.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa2023489f273b06937dd37c25b2cf2078" id="a2102aa80bc57783d96180f36e1f64f6aa2023489f273b06937dd37c25b2cf2078">relaxed_float_precision</a></td>
<td>
<p>Emit floating-point values with relaxed (human-friendly) precision.</p>
<aside class="m-note m-danger"><h4>Warning</h4><p>Setting this flag may cause serialized documents to no longer round-trip correctly since floats might have a less precise value upon being written out than they did when being read in. Use this flag at your own risk.</p></aside>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa4c8bfd397c155cf5841842cdbb556edd" id="a2102aa80bc57783d96180f36e1f64f6aa4c8bfd397c155cf5841842cdbb556edd">terse_key_value_pairs</a></td>
<td>
<p>Avoids the use of whitespace around key-value pairs.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a2102aa80bc57783d96180f36e1f64f6aa78b9ffac2669c1419aeb8dcc845a70bb" id="a2102aa80bc57783d96180f36e1f64f6aa78b9ffac2669c1419aeb8dcc845a70bb">force_multiline_arrays</a></td>
<td>
<p>Always print multiline arrays (one element per line).</p>
</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="abac3e84bbf1f2c90717fca107055f48d"><div>
<h3>
enum class <span class="m-doc-details-prefix">toml::<wbr/></span><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48d">node_type</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint8_t</a>
</h3>
<p>TOML node type identifiers.</p>
<table class="m-table m-fullwidth m-flat m-doc">
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
<tbody>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48da334c4a4c42fdb79d7ebc3e73b517e6f8" id="abac3e84bbf1f2c90717fca107055f48da334c4a4c42fdb79d7ebc3e73b517e6f8">none</a></td>
<td>
<p>Not-a-node.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48daaab9e1de16f38176f86d7a92ba337a8d" id="abac3e84bbf1f2c90717fca107055f48daaab9e1de16f38176f86d7a92ba337a8d">table</a></td>
<td>
<p>The node is a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48daf1f713c9e000f5d3f280adbd124df4f5" id="abac3e84bbf1f2c90717fca107055f48daf1f713c9e000f5d3f280adbd124df4f5">array</a></td>
<td>
<p>The node is a <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48dab45cffe084dd3d20d928bee85e7b0f21" id="abac3e84bbf1f2c90717fca107055f48dab45cffe084dd3d20d928bee85e7b0f21">string</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a>>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48da157db7df530023575515d366c9b672e8" id="abac3e84bbf1f2c90717fca107055f48da157db7df530023575515d366c9b672e8">integer</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><<a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a>>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48da387f7c620a256fdffcec74c1e7181a2a" id="abac3e84bbf1f2c90717fca107055f48da387f7c620a256fdffcec74c1e7181a2a">floating_point</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><double>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48da84e2c64f38f78ba3ea5c905ab5a2da27" id="abac3e84bbf1f2c90717fca107055f48da84e2c64f38f78ba3ea5c905ab5a2da27">boolean</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><bool>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48da5fc732311905cb27e82d67f4f6511f7f" id="abac3e84bbf1f2c90717fca107055f48da5fc732311905cb27e82d67f4f6511f7f">date</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><date>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48da07cc694b9b3fc636710fa08b6922c42b" id="abac3e84bbf1f2c90717fca107055f48da07cc694b9b3fc636710fa08b6922c42b">time</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><time>.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#abac3e84bbf1f2c90717fca107055f48dad611c46f8e65d9e049afe165de18c264" id="abac3e84bbf1f2c90717fca107055f48dad611c46f8e65d9e049afe165de18c264">date_time</a></td>
<td>
<p>The node is a <a class="m-doc poxy-injected" href="classtoml_1_1value.html">toml::value</a><<a class="m-doc poxy-injected" href="structtoml_1_1date__time.html">date_time</a>>.</p>
</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a73eba6a34e7c7c4a4d311100800e1bb5"><div>
<h3>
enum class <span class="m-doc-details-prefix">toml::<wbr/></span><a class="m-doc-self" href="#a73eba6a34e7c7c4a4d311100800e1bb5">value_flags</a>: <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">uint16_t</a>
</h3>
<p>Metadata associated with TOML values.</p>
<table class="m-table m-fullwidth m-flat m-doc">
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
<tbody>
<tr>
<td><a class="m-doc-self" href="#a73eba6a34e7c7c4a4d311100800e1bb5a334c4a4c42fdb79d7ebc3e73b517e6f8" id="a73eba6a34e7c7c4a4d311100800e1bb5a334c4a4c42fdb79d7ebc3e73b517e6f8">none</a></td>
<td>
<p>None.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a73eba6a34e7c7c4a4d311100800e1bb5a3d21a9285de175ffffc99cfa13df21df" id="a73eba6a34e7c7c4a4d311100800e1bb5a3d21a9285de175ffffc99cfa13df21df">format_as_binary</a></td>
<td>
<p>Format integer values as binary.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a73eba6a34e7c7c4a4d311100800e1bb5adfc26763754dabbdf97d3c8833a2e8ba" id="a73eba6a34e7c7c4a4d311100800e1bb5adfc26763754dabbdf97d3c8833a2e8ba">format_as_octal</a></td>
<td>
<p>Format integer values as octal.</p>
</td>
</tr>
<tr>
<td><a class="m-doc-self" href="#a73eba6a34e7c7c4a4d311100800e1bb5a4dd3fec464b7da02debfbc0bd4725c29" id="a73eba6a34e7c7c4a4d311100800e1bb5a4dd3fec464b7da02debfbc0bd4725c29">format_as_hexadecimal</a></td>
<td>
<p>Format integer values as hexadecimal.</p>
</td>
</tr>
</tbody>
</table>
</div></section>
</section>
<section>
<h2>Typedef documentation</h2>
<section class="m-doc-details" id="a2b87b5d257f54773683328031f453e76"><div>
<h3>
using <span class="m-doc-details-prefix">toml::<wbr/></span><a class="m-doc-self" href="#a2b87b5d257f54773683328031f453e76">default_formatter</a> = <a class="m-doc" href="classtoml_1_1toml__formatter.html">toml_<wbr/>formatter</a>
</h3>
<p>The 'default' formatter used by TOML objects when they are printed to a stream.</p>
<p>This is an alias for <a class="m-doc" href="classtoml_1_1toml__formatter.html">toml::<wbr/>toml_formatter</a>.</p>
</div></section>
<section class="m-doc-details" id="a98d783a1c89ce747982c2d24a5329882"><div>
<h3>
<div class="m-doc-template">
template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>>
</div>
using <span class="m-doc-details-prefix">toml::<wbr/></span><a class="m-doc-self" href="#a98d783a1c89ce747982c2d24a5329882">inserted_type_of</a> = <code class="m-note m-dim poxy-impl">/* ... */</code>
</h3>
<p>Metafunction for determining which node type would be constructed if an object of this type was inserted into a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a> or <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</p>
<pre class="m-code"><span class="k">static_assert</span><span class="p">(</span><span class="nn">std</span><span class="o">::</span><span class="n">is_same_v</span><span class="o"><</span><span class="nn">toml</span><span class="o">::</span><span class="nc">inserted_type_of</span><span class="o"><</span><span class="k">const</span> <span class="k">char</span><span class="o">*></span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nc">value</span><span class="o"><</span><span class="nn">std</span><span class="o">::</span><span class="nc">string</span><span class="o">></span><span class="p">);</span>
<span class="k">static_assert</span><span class="p">(</span><span class="nn">std</span><span class="o">::</span><span class="n">is_same_v</span><span class="o"><</span><span class="nn">toml</span><span class="o">::</span><span class="nc">inserted_type_of</span><span class="o"><</span><span class="k">int</span><span class="o">></span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nc">value</span><span class="o"><</span><span class="nc"><a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a></span><span class="o">></span><span class="p">);</span>
<span class="k">static_assert</span><span class="p">(</span><span class="nn">std</span><span class="o">::</span><span class="n">is_same_v</span><span class="o"><</span><span class="nn">toml</span><span class="o">::</span><span class="nc">inserted_type_of</span><span class="o"><</span><span class="k">float</span><span class="o">></span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nc">value</span><span class="o"><</span><span class="k">double</span><span class="o">></span><span class="p">);</span>
<span class="k">static_assert</span><span class="p">(</span><span class="nn">std</span><span class="o">::</span><span class="n">is_same_v</span><span class="o"><</span><span class="nn">toml</span><span class="o">::</span><span class="nc">inserted_type_of</span><span class="o"><</span><span class="k">bool</span><span class="o">></span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nc">value</span><span class="o"><</span><span class="k">bool</span><span class="o">></span><span class="p">);</span></pre><aside class="m-note m-info"><h4>Note</h4><p>This will return <a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a> for nodes and <a class="m-doc poxy-injected" href="classtoml_1_1node__view.html">node_views</a>, even though a more specific node subclass would actually be inserted. There is no way around this in a compile-time metafunction.</p></aside>
</div></section>
<section class="m-doc-details" id="af34a9fb3305e419784104609e6bbb7ac"><div>
<h3>
<div class="m-doc-template">
template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename T</span></span>>
</div>
using <span class="m-doc-details-prefix">toml::<wbr/></span><a class="m-doc-self" href="#af34a9fb3305e419784104609e6bbb7ac">optional</a> = <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/utility/optional.html" target="_blank">std::<wbr/>optional</a><T>
</h3>
<p>The 'optional' type used throughout the library.</p>
<aside class="m-note m-default"><h4>Remark</h4><p>By default this will be an alias for <a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/utility/optional.html" target="_blank">std::<wbr/>optional</a>, but you can change the optional type used by the library by defining <a class="m-doc" href="group__configuration.html#ga9c2c03f867eb6d76a5f65b06eeb1186e">TOML_<wbr/>OPTIONAL_<wbr/>TYPE</a>.</p></aside>
</div></section>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="a3024ba7b40cb19fa565b5ac80ac72c2d"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a3024ba7b40cb19fa565b5ac80ac72c2d">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> path) <span class="m-label m-success">noexcept</span></span></span>
</h3>
<p>Returns a view of the node matching a fully-qualified "TOML path".</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">root</td>
<td>The root node from which the path will be traversed.</td>
</tr>
<tr>
<td>path</td>
<td>The "TOML path" to traverse.</td>
</tr>
</tbody>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">config</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="sa">R</span><span class="s">"</span><span class="dl">(</span>
<span class="s">[foo]</span>
<span class="s">bar = [ 0, 1, 2, [ 3 ], { kek = 4 } ]</span>
<span class="dl">)</span><span class="s">"sv</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"foo.bar[2]"</span><span class="p">)</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"foo.bar[3][0]"</span><span class="p">)</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"foo.bar[4].kek"</span><span class="p">)</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">2</span>
<span class="go">3</span>
<span class="go">4</span></pre><aside class="m-note m-info"><h4>Note</h4><p>Keys in paths are interpreted literally, so whitespace (or lack thereof) matters:</p><pre class="m-code"><span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"foo.bar"</span><span class="p">)</span> <span class="c1">// same as config["foo"]["bar"]</span>
<span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"foo. bar"</span><span class="p">)</span> <span class="c1">// same as config["foo"][" bar"]</span>
<span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">"foo..bar"</span><span class="p">)</span> <span class="c1">// same as config["foo"][""]["bar"]</span>
<span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s">".foo.bar"</span><span class="p">)</span> <span class="c1">// same as config[""]["foo"]["bar"]</span></pre> <p><br/>Additionally, TOML allows '.' (period) characters to appear in keys if they are quoted strings. This function makes no allowance for this, instead treating all period characters as sub-table delimiters. If you have periods in your table keys, first consider:</p><ol><li>Not doing that</li><li>Using <a class="m-doc" href="classtoml_1_1node__view.html#a2dde12894f70530d80de45a03eae78fa">node_view::<wbr/>operator[]</a> instead.</li></ol></aside>
</div></section>
<section class="m-doc-details" id="aad864d99bf53e2b53a8fee28c2299d43"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#aad864d99bf53e2b53a8fee28c2299d43">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> path) <span class="m-label m-success">noexcept</span></span></span>
</h3>
<p>Returns a const view of the node matching a fully-qualified "TOML path".</p>
<aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="#a3024ba7b40cb19fa565b5ac80ac72c2d">toml::<wbr/>at_path(node&, std::<wbr/>string_view)</a></p></aside>
</div></section>
<section class="m-doc-details" id="af388e5adca27fada36874c8b9bc795ee"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#af388e5adca27fada36874c8b9bc795ee">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> path)</span></span>
</h3>
<p>Returns a view of the node matching a fully-qualified "TOML path".</p>
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga94867db67c98e0e9d4fbb70690951fbf">TOML_<wbr/>ENABLE_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="#a3024ba7b40cb19fa565b5ac80ac72c2d">toml::<wbr/>at_path(node&, std::<wbr/>string_view)</a></p></aside>
</div></section>
<section class="m-doc-details" id="a42b45f76519136534c835cc210b5220f"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a42b45f76519136534c835cc210b5220f">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> path)</span></span>
</h3>
<p>Returns a const view of the node matching a fully-qualified "TOML path".</p>
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga94867db67c98e0e9d4fbb70690951fbf">TOML_<wbr/>ENABLE_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="#a3024ba7b40cb19fa565b5ac80ac72c2d">toml::<wbr/>at_path(node&, std::<wbr/>string_view)</a></p></aside>
</div></section>
<section class="m-doc-details" id="a402a1973caa5c848ca494cac31d1085d"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a402a1973caa5c848ca494cac31d1085d">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) <span class="m-label m-success">noexcept</span></span></span>
</h3>
<p>Returns a view of the node matching a fully-qualified "TOML path".</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">root</td>
<td>The root node from which the path will be traversed.</td>
</tr>
<tr>
<td>path</td>
<td>The "TOML path" to traverse.</td>
</tr>
</tbody>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">config</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="sa">R</span><span class="s">"</span><span class="dl">(</span>
<span class="s">[foo]</span>
<span class="s">bar = [ 0, 1, 2, [ 3 ], { kek = 4 } ]</span>
<span class="dl">)</span><span class="s">"sv</span><span class="p">);</span>
<span class="nn">toml</span><span class="o">::</span><span class="nc">path</span> <span class="nf">path1</span><span class="p">(</span><span class="s">"foo.bar[2]"</span><span class="p">);</span>
<span class="nn">toml</span><span class="o">::</span><span class="nc">path</span> <span class="nf">path2</span><span class="p">(</span><span class="s">"foo.bar[4].kek"</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path1</span><span class="p">)</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path1</span><span class="p">.</span><span class="nf">parent_path</span><span class="p">())</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path2</span><span class="p">)</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path2</span><span class="p">.</span><span class="nf">parent_path</span><span class="p">())</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">2</span>
<span class="go">[ 0, 1, 2, [ 3 ], { kek = 4 } ]</span>
<span class="go">4</span>
<span class="go">{ kek = 4 }</span></pre><aside class="m-note m-info"><h4>Note</h4><p>Keys in paths are interpreted literally, so whitespace (or lack thereof) matters:</p><pre class="m-code"><span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">path</span><span class="p">(</span><span class="s">"foo.bar"</span><span class="p">))</span> <span class="c1">// same as config["foo"]["bar"]</span>
<span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">path</span><span class="p">(</span><span class="s">"foo. bar"</span><span class="p">))</span> <span class="c1">// same as config["foo"][" bar"]</span>
<span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">path</span><span class="p">(</span><span class="s">"foo..bar"</span><span class="p">))</span> <span class="c1">// same as config["foo"][""]["bar"]</span>
<span class="nn">toml</span><span class="o">::</span><span class="nf">at_path</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">path</span><span class="p">(</span><span class="s">".foo.bar"</span><span class="p">))</span> <span class="c1">// same as config[""]["foo"]["bar"]</span></pre> <p><br/>Additionally, TOML allows '.' (period) characters to appear in keys if they are quoted strings. This function makes no allowance for this, instead treating all period characters as sub-table delimiters.</p></aside>
</div></section>
<section class="m-doc-details" id="a3655200a65b1974b8bd13c1a4b5e45c1"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a3655200a65b1974b8bd13c1a4b5e45c1">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1node.html">node</a>& root,
const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) <span class="m-label m-success">noexcept</span></span></span>
</h3>
<p>Returns a const view of the node matching a fully-qualified "TOML path".</p>
<aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="#a402a1973caa5c848ca494cac31d1085d">toml::<wbr/>at_path(node&, const toml::<wbr/>path& path)</a></p></aside>
</div></section>
<section class="m-doc-details" id="a7a137fbfb3f257680292c20bce18a55d"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="#af34a9fb3305e419784104609e6bbb7ac">optional</a><<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a>> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a7a137fbfb3f257680292c20bce18a55d">get_line</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc" href="#afb852fa22a8b3ea9d200d645b9d5c308">source_<wbr/>index</a> line_num) <span class="m-label m-primary">constexpr</span> <span class="m-label m-success">noexcept</span></span></span>
</h3>
<p>Returns the line at the specified line number, from the specified document.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The document.</td>
</tr>
<tr>
<td>line_num</td>
<td>The line number (1-based).</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td>The specified line, excluding any possible trailing carriage return or line feed character.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">doc</span> <span class="o">=</span> <span class="s">"alpha = 1</span><span class="se">\n</span><span class="s">beta = 2"sv</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">second_line</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">get_line</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="s">"The second line says </span><span class="se">\"</span><span class="s">"</span> <span class="o"><<</span> <span class="n">second_line</span><span class="p">.</span><span class="nf">value</span><span class="p">()</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\"\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">The second line says "beta = 2"</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>Returns an empty <code>optional</code> when the specified line number is out of range, i.e., when the line number is zero or greater than the total number of lines of the specified document.</p></aside>
</div></section>
<section class="m-doc-details" id="a8a37f07ea9c0a841be1352143b3cbc52"><div>
<h3>
<div class="m-doc-template">
template <<span class="m-doc-template-params"><span class="m-doc-template-param">typename Char</span></span>>
</div>
<span class="m-doc-wrap-bumper"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>basic_ostream</a><Char>& <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a8a37f07ea9c0a841be1352143b3cbc52">operator<<</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>basic_ostream</a><Char>& lhs,
<a class="m-doc" href="#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> rhs)</span></span>
</h3>
<p>Pretty-prints the value of a node_type to a stream.</p>
<pre class="m-code"><span class="k">auto</span> <span class="n">arr</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nc">array</span><span class="p">{</span> <span class="mi">1</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="s">"3"</span><span class="p">,</span> <span class="k">false</span> <span class="p">};</span>
<span class="k">for</span> <span class="p">(</span><span class="nc"><a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a></span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">arr</span><span class="p">.</span><span class="nf">size</span><span class="p">()</span> <span class="n">i</span><span class="o">++</span><span class="p">)</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="s">"Element ["sv</span> <span class="o"><<</span> <span class="n">i</span> <span class="o"><<</span> <span class="s">"] is: "sv</span> <span class="o"><<</span> <span class="n">arr</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="nf">type</span><span class="p">()</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">Element [0] is: integer</span>
<span class="go">Element [1] is: floating-point</span>
<span class="go">Element [2] is: string</span>
<span class="go">Element [3] is: boolean</span></pre>
</div></section>
<section class="m-doc-details" id="ada8654fb4ceef15c20fc1d5e0cc734dd"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ada8654fb4ceef15c20fc1d5e0cc734dd">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> source_path = {})</span></span>
</h3>
<p>Parses a TOML document from a string view.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="s">"a = 3"sv</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a20fa3e08d72759083fb17c772a357043"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a20fa3e08d72759083fb17c772a357043">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>&& source_path)</span></span>
</h3>
<p>Parses a TOML document from a string view.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="s">"a = 3"sv</span><span class="p">,</span> <span class="s">"foo.toml"</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="ae9ee4300ddfbd72b7237283ab8d97618"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ae9ee4300ddfbd72b7237283ab8d97618">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> source_path = {})</span></span>
</h3>
<p>Parses a TOML document from a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a> string view.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="sa">u8</span><span class="s">"a = 3"sv</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a02a2724564149ad8439c0457357308b8"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a02a2724564149ad8439c0457357308b8">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>&& source_path)</span></span>
</h3>
<p>Parses a TOML document from a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a> string view.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="sa">u8</span><span class="s">"a = 3"sv</span><span class="p">,</span> <span class="s">"foo.toml"</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a01565f26a7982d162949bac3b554a334"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a01565f26a7982d162949bac3b554a334">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> source_path)</span></span>
</h3>
<p>Parses a TOML document from a string view.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga94867db67c98e0e9d4fbb70690951fbf">TOML_<wbr/>ENABLE_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside><pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="s">"a = 3"sv</span><span class="p">,</span> <span class="sa">L</span><span class="s">"foo.toml"</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="ac7767943620762c22b6341dc6682cc2d"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ac7767943620762c22b6341dc6682cc2d">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" target="_blank">std::<wbr/>istream</a>& doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> source_path)</span></span>
</h3>
<p>Parses a TOML document from a stream.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga94867db67c98e0e9d4fbb70690951fbf">TOML_<wbr/>ENABLE_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside><pre class="m-code"><span class="nn">std</span><span class="o">::</span><span class="nc">stringstream</span> <span class="n">ss</span><span class="p">;</span>
<span class="n">ss</span> <span class="o"><<</span> <span class="s">"a = 3"sv</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="n">ss</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a38852451309f406db281f17334ea8dfe"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a38852451309f406db281f17334ea8dfe">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> source_path)</span></span>
</h3>
<p>Parses a TOML document from a <a class="m-doc poxy-injected poxy-external poxy-cppreference" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">char8_t</a> string view.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga94867db67c98e0e9d4fbb70690951fbf">TOML_<wbr/>ENABLE_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside><pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="sa">u8</span><span class="s">"a = 3"sv</span><span class="p">,</span> <span class="sa">L</span><span class="s">"foo.toml"</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a2ee84ffccded737ab40afcb8122d8277"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a2ee84ffccded737ab40afcb8122d8277">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" target="_blank">std::<wbr/>istream</a>& doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> source_path = {})</span></span>
</h3>
<p>Parses a TOML document from a stream.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="nn">std</span><span class="o">::</span><span class="nc">stringstream</span> <span class="n">ss</span><span class="p">;</span>
<span class="n">ss</span> <span class="o"><<</span> <span class="s">"a = 3"sv</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="n">ss</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a8079e71bd86722701ca91828c6709305"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a8079e71bd86722701ca91828c6709305">parse</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" target="_blank">std::<wbr/>istream</a>& doc,
<a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>&& source_path)</span></span>
</h3>
<p>Parses a TOML document from a stream.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">doc</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
<tr>
<td>source_path</td>
<td>The path used to initialize each node's <code>source().path</code>. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="nn">std</span><span class="o">::</span><span class="nc">stringstream</span> <span class="n">ss</span><span class="p">;</span>
<span class="n">ss</span> <span class="o"><<</span> <span class="s">"a = 3"sv</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse</span><span class="p">(</span><span class="n">ss</span><span class="p">,</span> <span class="s">"foo.toml"</span><span class="p">);</span>
<span class="nn">std</span><span class="o">::</span><span class="nc">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">[</span><span class="s">"a"</span><span class="p">]</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">3</span></pre>
</div></section>
<section class="m-doc-details" id="a8dbc58dad43c3b66f4476a7131f5741a"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a8dbc58dad43c3b66f4476a7131f5741a">parse_file</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> file_path)</span></span>
</h3>
<p>Parses a TOML document from a file.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">file_path</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="nn">toml</span><span class="o">::</span><span class="nc"><a class="m-doc poxy-injected" href="classtoml_1_1parse__result.html">parse_result</a></span> <span class="nf">get_foo_toml</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse_file</span><span class="p">(</span><span class="s">"foo.toml"</span><span class="p">);</span>
<span class="p">}</span></pre>
</div></section>
<section class="m-doc-details" id="acdbabd4b771d221fe98b0053d848d69d"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#acdbabd4b771d221fe98b0053d848d69d">parse_file</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>u8string_view</a> file_path)</span></span>
</h3>
<p>Parses a TOML document from a file.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">file_path</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<pre class="m-code"><span class="nn">toml</span><span class="o">::</span><span class="nc"><a class="m-doc poxy-injected" href="classtoml_1_1parse__result.html">parse_result</a></span> <span class="nf">get_foo_toml</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse_file</span><span class="p">(</span><span class="sa">u8</span><span class="s">"foo.toml"</span><span class="p">);</span>
<span class="p">}</span></pre>
</div></section>
<section class="m-doc-details" id="ad425af491341206589ca6acc37c3b19e"><div>
<h3>
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1parse__result.html">parse_<wbr/>result</a> <span class="m-doc-details-prefix">toml::<wbr/></span></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ad425af491341206589ca6acc37c3b19e">parse_file</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-cppreference poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> file_path)</span></span>
</h3>
<p>Parses a TOML document from a file.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">file_path</td>
<td>The TOML document to parse. Must be valid UTF-8.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><strong><em>With exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>. <strong><em>Without exceptions:</em></strong> A <a class="m-doc" href="classtoml_1_1parse__result.html">toml::<wbr/>parse_result</a>.</td>
</tr>
</tfoot>
</table>
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga94867db67c98e0e9d4fbb70690951fbf">TOML_<wbr/>ENABLE_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside><pre class="m-code"><span class="nn">toml</span><span class="o">::</span><span class="nc"><a class="m-doc poxy-injected" href="classtoml_1_1parse__result.html">parse_result</a></span> <span class="nf">get_foo_toml</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="nn">toml</span><span class="o">::</span><span class="nf">parse_file</span><span class="p">(</span><span class="sa">L</span><span class="s">"foo.toml"</span><span class="p">);</span>
<span class="p">}</span></pre>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-doc-search-content">
<form>
<input autocomplete="off" autofocus="autofocus" disabled="disabled" id="search-input" name="q" placeholder="Loading …" spellcheck="false" type="search"/>
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
<div class="m-text m-dim m-text-center" id="search-help">
<p class="m-noindent">Search for symbols, directories, files, pages or
modules. You can omit any prefix from the symbol or file path; adding a
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
/ <span class="m-label m-dim">↑</span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
copy a link to the result using <span class="m-label m-dim">⌘</span>
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
</div>
<div class="m-text m-warning m-text-center" id="search-notfound">Sorry, nothing was found.</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v2.js"></script><script>install_mcss_search_shim();</script>
<script async="async" src="searchdata-v2.js"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<a class="poxy-external" href="https://github.com/marzer/tomlplusplus" target="_blank">GitHub</a>
• <a class="poxy-external" href="https://github.com/marzer/tomlplusplus/issues" target="_blank">Report an issue</a>
• <a class="sponsor poxy-external" href="https://github.com/sponsors/marzer" target="_blank">Become a sponsor</a>
• <a class="poxy-external" href="https://github.com/marzer/tomlplusplus/blob/master/LICENSE" target="_blank">License</a>
• <a download="" href="toml++.tagfile.xml" target="_blank" type="text/xml">Doxygen tagfile</a>
<br/><br/>
Site generated using <a class="poxy-external" href="https://github.com/marzer/poxy/" target="_blank">Poxy</a>
</div>
</div>
</div>
</nav></footer>
</body></html>
|
