-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathapi.html
1405 lines (1248 loc) · 158 KB
/
api.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>API Reference — fmt 4.0.0 documentation</title>
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/breathe.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
SOURCELINK_SUFFIX: '.txt',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<meta name="description" content="Small, safe and fast formatting library">
<meta name="keywords" content="C++, formatting, printf, string, library">
<meta name="author" content="Victor Zverovich">
<link rel="stylesheet" href="_static/fmt.css">
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-20116650-4"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-20116650-4');
</script>
</head>
<body role="document">
<nav class="navbar navbar-inverse">
<div class="tb-container">
<div class="row">
<div class="navbar-content">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed"
data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">{fmt}</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"
role="button" aria-expanded="false">4.0.0
<span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://fmt.dev/10.2.0">10.2.0</a></li>
<li><a href="https://fmt.dev/10.1.1">10.1.1</a></li>
<li><a href="https://fmt.dev/10.1.0">10.1.0</a></li>
</ul>
</li>
<li><a href="contents.html">Contents</a></li>
<li><a href="usage.html">Usage</a></li>
<li class="active"><a href="api.html">API
<span class="sr-only">(current)</span></a></li>
<li><a href="syntax.html">Syntax</a></li>
</ul>
<form class="navbar-form navbar-right" role="search" action="search.html"
method="get">
<div class="form-group">
<input type="text" name="q" class="form-control"
placeholder="Search" >
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
</div>
</nav>
<div class="tb-container">
<div class="row">
<div class="content">
<section id="api-reference">
<span id="string-formatting-api"></span><h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
<p>All functions and classes provided by the fmt library reside
in namespace <code class="docutils literal notranslate"><span class="pre">fmt</span></code> and macros have prefix <code class="docutils literal notranslate"><span class="pre">FMT_</span></code>. For brevity the
namespace is usually omitted in examples.</p>
<section id="format-api">
<h2>Format API<a class="headerlink" href="#format-api" title="Permalink to this headline">¶</a></h2>
<p>The following functions defined in <code class="docutils literal notranslate"><span class="pre">fmt/format.h</span></code> use <a class="reference internal" href="syntax.html#syntax"><span class="std std-ref">format string
syntax</span></a> similar to the one used by Python’s <a class="reference external" href="http://docs.python.org/3/library/stdtypes.html#str.format">str.format</a> function.
They take <em>format_str</em> and <em>args</em> as arguments.</p>
<p><em>format_str</em> is a format string that contains literal text and replacement
fields surrounded by braces <code class="docutils literal notranslate"><span class="pre">{}</span></code>. The fields are replaced with formatted
arguments in the resulting string.</p>
<p><em>args</em> is an argument list representing arbitrary arguments.</p>
<p>The <a class="reference external" href="https://github.com/fmtlib/fmt/blob/master/README.rst#speed-tests">performance of the format API</a> is close
to that of glibc’s <code class="docutils literal notranslate"><span class="pre">printf</span></code> and better than the performance of IOStreams.
For even better speed use the <a class="reference internal" href="#write-api">write API</a>.</p>
<span class="target" id="format"></span><dl class="cpp function">
<dt id="_CPPv4N3fmt6formatE10CStringRef7ArgList">
<span id="_CPPv3N3fmt6formatE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt6formatE10CStringRef7ArgList"></span><span id="fmt::format__CStringRef.ArgList"></span><span class="target" id="format_8h_1a638f25c535b3bfa12dc1478b11885b6f"></span>std::string <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">format</code><span class="sig-paren">(</span>CStringRef <em>format_str</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt6formatE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Formats arguments and returns the result as a string.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">format</span><span class="p">(</span><span class="s">"The answer is {}"</span><span class="p">,</span><span class="w"> </span><span class="mi">42</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmtli7_formatEPKcNSt6size_tE">
<span id="_CPPv3N3fmtli7_formatEPKcNSt6size_tE"></span><span id="_CPPv2N3fmtli7_formatEPKcNSt6size_tE"></span><span class="target" id="format_8h_1a063713385c34b8a3e7620019920c1de0"></span>internal::UdlFormat<char> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">operator""_format</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>s</em>, std::size_t<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmtli7_formatEPKcNSt6size_tE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>C++11 literal equivalent of <a class="reference internal" href="#_CPPv4N3fmt6formatE10CStringRef7ArgList" title="fmt::format"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">fmt::format()</span></code></a>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">using</span><span class="w"> </span><span class="k">namespace</span><span class="w"> </span><span class="nn">fmt</span><span class="o">::</span><span class="nn">literals</span><span class="p">;</span>
<span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"The answer is {}"</span><span class="n">_format</span><span class="p">(</span><span class="mi">42</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<span class="target" id="print"></span><dl class="cpp function">
<dt id="_CPPv4N3fmt5printE10CStringRef7ArgList">
<span id="_CPPv3N3fmt5printE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt5printE10CStringRef7ArgList"></span><span id="fmt::print__CStringRef.ArgList"></span><span class="target" id="format_8h_1a7cfad68e64995774f11072aaf5008e8a"></span>void <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">print</code><span class="sig-paren">(</span>CStringRef <em>format_str</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt5printE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Prints formatted data to <code class="docutils literal notranslate"><span class="pre">stdout</span></code>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">print</span><span class="p">(</span><span class="s">"Elapsed time: {0:.2f} seconds"</span><span class="p">,</span><span class="w"> </span><span class="mf">1.23</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt5printEPNSt4FILEE10CStringRef7ArgList">
<span id="_CPPv3N3fmt5printEPNSt4FILEE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt5printEPNSt4FILEE10CStringRef7ArgList"></span><span id="fmt::print__std::FILEP.CStringRef.ArgList"></span><span class="target" id="format_8h_1a78a8e17e6bc20560466418560a1d0a2a"></span>void <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">print</code><span class="sig-paren">(</span>std::FILE *<em>f</em>, CStringRef <em>format_str</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt5printEPNSt4FILEE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Prints formatted data to the file <em>f</em>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">print</span><span class="p">(</span><span class="n">stderr</span><span class="p">,</span><span class="w"> </span><span class="s">"Don't {}!"</span><span class="p">,</span><span class="w"> </span><span class="s">"panic"</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I00EN3fmt14BasicFormatterE">
<span id="_CPPv3I00EN3fmt14BasicFormatterE"></span><span id="_CPPv2I00EN3fmt14BasicFormatterE"></span>template<typename <code class="sig-name descname">CharType</code>, typename <code class="sig-name descname">ArgFormatter</code>><br /><span class="target" id="classfmt_1_1_basic_formatter"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">BasicFormatter</code> : <em class="property">private</em> fmt::internal::FormatterBase<a class="headerlink" href="#_CPPv4I00EN3fmt14BasicFormatterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>This template formats data and writes the output to a writer. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Types</p>
<dl class="cpp type">
<dt id="_CPPv4N3fmt14BasicFormatter4CharE">
<span id="_CPPv3N3fmt14BasicFormatter4CharE"></span><span id="_CPPv2N3fmt14BasicFormatter4CharE"></span><span id="fmt::BasicFormatter::Char"></span><span class="target" id="classfmt_1_1_basic_formatter_1af8270b25395aeb82b8c72c370c5cf13a"></span><em class="property">typedef </em><a class="reference internal" href="#_CPPv4I00EN3fmt14BasicFormatterE" title="fmt::BasicFormatter::CharType">CharType</a> <code class="sig-name descname">Char</code><a class="headerlink" href="#_CPPv4N3fmt14BasicFormatter4CharE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The character type for the output. </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt14BasicFormatter14BasicFormatterERK7ArgListR11BasicWriterI4CharE">
<span id="_CPPv3N3fmt14BasicFormatter14BasicFormatterERK7ArgListR11BasicWriterI4CharE"></span><span id="_CPPv2N3fmt14BasicFormatter14BasicFormatterERK7ArgListR11BasicWriterI4CharE"></span><span id="fmt::BasicFormatter::BasicFormatter__ArgListCR.BasicWriter:Char:R"></span><span class="target" id="classfmt_1_1_basic_formatter_1a2b190901681ff0413dc60522fe158fdc"></span><code class="sig-name descname">BasicFormatter</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> &<em>args</em>, <a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4N3fmt14BasicFormatter4CharE" title="fmt::BasicFormatter::Char">Char</a>> &<em>w</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt14BasicFormatter14BasicFormatterERK7ArgListR11BasicWriterI4CharE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs a <code class="docutils literal notranslate"><span class="pre">BasicFormatter</span></code> object. References to the arguments and
the writer are stored in the formatter object so make sure they have
appropriate lifetimes.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt14BasicFormatter6writerEv">
<span id="_CPPv3N3fmt14BasicFormatter6writerEv"></span><span id="_CPPv2N3fmt14BasicFormatter6writerEv"></span><span id="fmt::BasicFormatter::writer"></span><span class="target" id="classfmt_1_1_basic_formatter_1ac1d0cc6ac6a7cc768f71730f2299d6e8"></span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4N3fmt14BasicFormatter4CharE" title="fmt::BasicFormatter::Char">Char</a>> &<code class="sig-name descname">writer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt14BasicFormatter6writerEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns a reference to the writer associated with this formatter. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt14BasicFormatter6formatE15BasicCStringRefI4CharE">
<span id="_CPPv3N3fmt14BasicFormatter6formatE15BasicCStringRefI4CharE"></span><span id="_CPPv2N3fmt14BasicFormatter6formatE15BasicCStringRefI4CharE"></span><span id="fmt::BasicFormatter::format__BasicCStringRef:Char:"></span><span class="target" id="classfmt_1_1_basic_formatter_1a63acecbbf9681005f3c7eb4d42a54bf7"></span>void <code class="sig-name descname">format</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt15BasicCStringRefE" title="fmt::BasicCStringRef">BasicCStringRef</a><<a class="reference internal" href="#_CPPv4N3fmt14BasicFormatter4CharE" title="fmt::BasicFormatter::Char">Char</a>> <em>format_str</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt14BasicFormatter6formatE15BasicCStringRefI4CharE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats stored arguments and writes the output to the writer. </p>
</dd></dl>
</div>
</dd></dl>
<section id="date-and-time-formatting">
<h3>Date and time formatting<a class="headerlink" href="#date-and-time-formatting" title="Permalink to this headline">¶</a></h3>
<p>The library supports <a class="reference external" href="http://en.cppreference.com/w/cpp/chrono/c/strftime">strftime</a>-like date and time
formatting:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"fmt/time.h"</span>
<span class="n">std</span><span class="o">::</span><span class="kt">time_t</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">time</span><span class="p">(</span><span class="k">nullptr</span><span class="p">);</span>
<span class="c1">// Prints "The date is 2016-04-29." (with the current date)</span>
<span class="n">fmt</span><span class="o">::</span><span class="n">print</span><span class="p">(</span><span class="s">"The date is {:%Y-%m-%d}."</span><span class="p">,</span><span class="w"> </span><span class="o">*</span><span class="n">std</span><span class="o">::</span><span class="n">localtime</span><span class="p">(</span><span class="o">&</span><span class="n">t</span><span class="p">));</span>
</pre></div>
</div>
<p>The format string syntax is described in the documentation of
<a class="reference external" href="http://en.cppreference.com/w/cpp/chrono/c/strftime">strftime</a>.</p>
</section>
<section id="formatting-user-defined-types">
<h3>Formatting user-defined types<a class="headerlink" href="#formatting-user-defined-types" title="Permalink to this headline">¶</a></h3>
<p>A custom <code class="docutils literal notranslate"><span class="pre">format_arg</span></code> function may be implemented and used to format any
user-defined type. That is how date and time formatting described in the
previous section is implemented in <code class="file docutils literal notranslate"><span class="pre">fmt/time.h</span></code>. The following example
shows how to implement custom formatting for a user-defined structure.</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">MyStruct</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">;</span><span class="w"> </span><span class="p">};</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">format_arg</span><span class="p">(</span><span class="n">fmt</span><span class="o">::</span><span class="n">BasicFormatter</span><span class="o"><</span><span class="kt">char</span><span class="o">></span><span class="w"> </span><span class="o">&</span><span class="n">f</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*&</span><span class="n">format_str</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">MyStruct</span><span class="w"> </span><span class="o">&</span><span class="n">s</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">f</span><span class="p">.</span><span class="n">writer</span><span class="p">().</span><span class="n">write</span><span class="p">(</span><span class="s">"[MyStruct: a={:.1f}, b={:.2f}]"</span><span class="p">,</span><span class="w"> </span><span class="n">s</span><span class="p">.</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">s</span><span class="p">.</span><span class="n">b</span><span class="p">);</span>
<span class="p">}</span>
<span class="n">MyStruct</span><span class="w"> </span><span class="n">m</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">};</span>
<span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">s</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">format</span><span class="p">(</span><span class="s">"m={}"</span><span class="p">,</span><span class="w"> </span><span class="n">n</span><span class="p">);</span>
<span class="c1">// s == "m=[MyStruct: a=1.0, b=2.00]"</span>
</pre></div>
</div>
<p>Note in the example above the <code class="docutils literal notranslate"><span class="pre">format_arg</span></code> function ignores the contents of
<code class="docutils literal notranslate"><span class="pre">format_str</span></code> so the type will always be formatted as specified. See
<code class="docutils literal notranslate"><span class="pre">format_arg</span></code> in <code class="file docutils literal notranslate"><span class="pre">fmt/time.h</span></code> for an advanced example of how to use
the <code class="docutils literal notranslate"><span class="pre">format_str</span></code> argument to customize the formatted output.</p>
<p>This section shows how to define a custom format function for a user-defined
type. The next section describes how to get <code class="docutils literal notranslate"><span class="pre">fmt</span></code> to use a conventional stream
output <code class="docutils literal notranslate"><span class="pre">operator<<</span></code> when one is defined for a user-defined type.</p>
</section>
<section id="std-ostream-support">
<h3><code class="docutils literal notranslate"><span class="pre">std::ostream</span></code> support<a class="headerlink" href="#std-ostream-support" title="Permalink to this headline">¶</a></h3>
<p>The header <code class="docutils literal notranslate"><span class="pre">fmt/ostream.h</span></code> provides <code class="docutils literal notranslate"><span class="pre">std::ostream</span></code> support including
formatting of user-defined types that have overloaded <code class="docutils literal notranslate"><span class="pre">operator<<</span></code>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"fmt/ostream.h"</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Date</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">year_</span><span class="p">,</span><span class="w"> </span><span class="n">month_</span><span class="p">,</span><span class="w"> </span><span class="n">day_</span><span class="p">;</span>
<span class="k">public</span><span class="o">:</span>
<span class="w"> </span><span class="n">Date</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">year</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">month</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">day</span><span class="p">)</span><span class="o">:</span><span class="w"> </span><span class="n">year_</span><span class="p">(</span><span class="n">year</span><span class="p">),</span><span class="w"> </span><span class="n">month_</span><span class="p">(</span><span class="n">month</span><span class="p">),</span><span class="w"> </span><span class="n">day_</span><span class="p">(</span><span class="n">day</span><span class="p">)</span><span class="w"> </span><span class="p">{}</span>
<span class="w"> </span><span class="k">friend</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">ostream</span><span class="o">&</span><span class="k">operator</span><span class="o"><<</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">ostream</span><span class="o">&</span><span class="n">os</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">Date</span><span class="w"> </span><span class="o">&</span><span class="n">d</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">os</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">d</span><span class="p">.</span><span class="n">year_</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="sc">'-'</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">d</span><span class="p">.</span><span class="n">month_</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="sc">'-'</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">d</span><span class="p">.</span><span class="n">day_</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">};</span>
<span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">s</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">format</span><span class="p">(</span><span class="s">"The date is {}"</span><span class="p">,</span><span class="w"> </span><span class="n">Date</span><span class="p">(</span><span class="mi">2012</span><span class="p">,</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span><span class="w"> </span><span class="mi">9</span><span class="p">));</span>
<span class="c1">// s == "The date is 2012-12-9"</span>
</pre></div>
</div>
<dl class="cpp function">
<dt id="_CPPv4N3fmt5printERNSt7ostreamE10CStringRef7ArgList">
<span id="_CPPv3N3fmt5printERNSt7ostreamE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt5printERNSt7ostreamE10CStringRef7ArgList"></span><span id="fmt::print__osR.CStringRef.ArgList"></span><span class="target" id="ostream_8h_1a7ef9196e61600e71d751a14b3facea2e"></span>void <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">print</code><span class="sig-paren">(</span>std::ostream &<em>os</em>, CStringRef <em>format_str</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt5printERNSt7ostreamE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Prints formatted data to the stream <em>os</em>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">print</span><span class="p">(</span><span class="n">cerr</span><span class="p">,</span><span class="w"> </span><span class="s">"Don't {}!"</span><span class="p">,</span><span class="w"> </span><span class="s">"panic"</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
</section>
<section id="argument-formatters">
<h3>Argument formatters<a class="headerlink" href="#argument-formatters" title="Permalink to this headline">¶</a></h3>
<p>It is possible to change the way arguments are formatted by providing a
custom argument formatter class:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="c1">// A custom argument formatter that formats negative integers as unsigned</span>
<span class="c1">// with the ``x`` format specifier.</span>
<span class="k">class</span><span class="w"> </span><span class="nc">CustomArgFormatter</span><span class="w"> </span><span class="o">:</span>
<span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">BasicArgFormatter</span><span class="o"><</span><span class="n">CustomArgFormatter</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="o">></span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">public</span><span class="o">:</span>
<span class="w"> </span><span class="n">CustomArgFormatter</span><span class="p">(</span><span class="n">fmt</span><span class="o">::</span><span class="n">BasicFormatter</span><span class="o"><</span><span class="kt">char</span><span class="p">,</span><span class="w"> </span><span class="n">CustomArgFormatter</span><span class="o">></span><span class="w"> </span><span class="o">&</span><span class="n">f</span><span class="p">,</span>
<span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">FormatSpec</span><span class="w"> </span><span class="o">&</span><span class="n">s</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">fmt</span><span class="p">)</span>
<span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">BasicArgFormatter</span><span class="o"><</span><span class="n">CustomArgFormatter</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="o">></span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="w"> </span><span class="n">s</span><span class="p">,</span><span class="w"> </span><span class="n">fmt</span><span class="p">)</span><span class="w"> </span><span class="p">{}</span>
<span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="n">visit_int</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">value</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">spec</span><span class="p">().</span><span class="n">type</span><span class="p">()</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="sc">'x'</span><span class="p">)</span>
<span class="w"> </span><span class="n">visit_uint</span><span class="p">(</span><span class="n">value</span><span class="p">);</span><span class="w"> </span><span class="c1">// convert to unsigned and format</span>
<span class="w"> </span><span class="k">else</span>
<span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">BasicArgFormatter</span><span class="o"><</span><span class="n">CustomArgFormatter</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="o">>::</span><span class="n">visit_int</span><span class="p">(</span><span class="n">value</span><span class="p">);</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">};</span>
<span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="nf">custom_format</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">format_str</span><span class="p">,</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">ArgList</span><span class="w"> </span><span class="n">args</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">MemoryWriter</span><span class="w"> </span><span class="n">writer</span><span class="p">;</span>
<span class="w"> </span><span class="c1">// Pass custom argument formatter as a template arg to BasicFormatter.</span>
<span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">BasicFormatter</span><span class="o"><</span><span class="kt">char</span><span class="p">,</span><span class="w"> </span><span class="n">CustomArgFormatter</span><span class="o">></span><span class="w"> </span><span class="n">formatter</span><span class="p">(</span><span class="n">args</span><span class="p">,</span><span class="w"> </span><span class="n">writer</span><span class="p">);</span>
<span class="w"> </span><span class="n">formatter</span><span class="p">.</span><span class="n">format</span><span class="p">(</span><span class="n">format_str</span><span class="p">);</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">writer</span><span class="p">.</span><span class="n">str</span><span class="p">();</span>
<span class="p">}</span>
<span class="n">FMT_VARIADIC</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="p">,</span><span class="w"> </span><span class="n">custom_format</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="p">)</span>
<span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">s</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">custom_format</span><span class="p">(</span><span class="s">"{:x}"</span><span class="p">,</span><span class="w"> </span><span class="mi">-42</span><span class="p">);</span><span class="w"> </span><span class="c1">// s == "ffffffd6"</span>
</pre></div>
</div>
<dl class="cpp class">
<dt id="_CPPv4I00EN3fmt10ArgVisitorE">
<span id="_CPPv3I00EN3fmt10ArgVisitorE"></span><span id="_CPPv2I00EN3fmt10ArgVisitorE"></span>template<typename <code class="sig-name descname">Impl</code>, typename <code class="sig-name descname">Result</code>><br /><span class="target" id="classfmt_1_1_arg_visitor"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">ArgVisitor</code><a class="headerlink" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>An argument visitor based on the <a class="reference external" href="http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern">curiously recurring template pattern</a>.</p>
<p>To use <a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ArgVisitor</span></code></a> define a subclass that implements some or all of the
visit methods with the same signatures as the methods in <a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ArgVisitor</span></code></a>,
for example, <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor9visit_intEi" title="fmt::ArgVisitor::visit_int"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_int()</span></code></a>.
Pass the subclass as the <em>Impl</em> template parameter. Then calling
<a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor5visitERK3Arg" title="fmt::ArgVisitor::visit"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit()</span></code></a> for some argument will dispatch to a visit method
specific to the argument type. For example, if the argument type is
<code class="docutils literal notranslate"><span class="pre">double</span></code> then the <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor12visit_doubleEd" title="fmt::ArgVisitor::visit_double"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_double()</span></code></a> method of a subclass
will be called. If the subclass doesn’t contain a method with this signature,
then a corresponding method of <a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ArgVisitor</span></code></a> will be called.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">MyArgVisitor</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">ArgVisitor</span><span class="o"><</span><span class="n">MyArgVisitor</span><span class="p">,</span><span class="w"> </span><span class="kt">void</span><span class="o">></span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">public</span><span class="o">:</span>
<span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="n">visit_int</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">value</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">print</span><span class="p">(</span><span class="s">"{}"</span><span class="p">,</span><span class="w"> </span><span class="n">value</span><span class="p">);</span><span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="n">visit_double</span><span class="p">(</span><span class="kt">double</span><span class="w"> </span><span class="n">value</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">print</span><span class="p">(</span><span class="s">"{}"</span><span class="p">,</span><span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="p">);</span><span class="w"> </span><span class="p">}</span>
<span class="p">};</span>
</pre></div>
</div>
</p>
</p>
<p>Subclassed by fmt::internal::ArgFormatterBase< ArgFormatter< Char >, Char, FormatSpec >, fmt::internal::ArgFormatterBase< PrintfArgFormatter< Char >, Char, FormatSpec >, fmt::internal::ArgConverter< T ></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor9visit_intEi">
<span id="_CPPv3N3fmt10ArgVisitor9visit_intEi"></span><span id="_CPPv2N3fmt10ArgVisitor9visit_intEi"></span><span id="fmt::ArgVisitor::visit_int__i"></span><span class="target" id="classfmt_1_1_arg_visitor_1ac6d79e3d931a9f56f40bca08f8651cdf"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_int</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor9visit_intEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits an <code class="docutils literal notranslate"><span class="pre">int</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor15visit_long_longE8LongLong">
<span id="_CPPv3N3fmt10ArgVisitor15visit_long_longE8LongLong"></span><span id="_CPPv2N3fmt10ArgVisitor15visit_long_longE8LongLong"></span><span id="fmt::ArgVisitor::visit_long_long__LongLong"></span><span class="target" id="classfmt_1_1_arg_visitor_1ab5687cccaae516d3e6e94775737ff798"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_long_long</code><span class="sig-paren">(</span>LongLong <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor15visit_long_longE8LongLong" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a <code class="docutils literal notranslate"><span class="pre">long</span> <span class="pre">long</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor10visit_uintEj">
<span id="_CPPv3N3fmt10ArgVisitor10visit_uintEj"></span><span id="_CPPv2N3fmt10ArgVisitor10visit_uintEj"></span><span id="fmt::ArgVisitor::visit_uint__unsigned"></span><span class="target" id="classfmt_1_1_arg_visitor_1a51494a02bd4573280fc1cc6fc921f871"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_uint</code><span class="sig-paren">(</span>unsigned <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor10visit_uintEj" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits an <code class="docutils literal notranslate"><span class="pre">unsigned</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor16visit_ulong_longE9ULongLong">
<span id="_CPPv3N3fmt10ArgVisitor16visit_ulong_longE9ULongLong"></span><span id="_CPPv2N3fmt10ArgVisitor16visit_ulong_longE9ULongLong"></span><span id="fmt::ArgVisitor::visit_ulong_long__ULongLong"></span><span class="target" id="classfmt_1_1_arg_visitor_1ac4424926e9c138b3503039d91c18c087"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_ulong_long</code><span class="sig-paren">(</span>ULongLong <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor16visit_ulong_longE9ULongLong" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits an <code class="docutils literal notranslate"><span class="pre">unsigned</span> <span class="pre">long</span> <span class="pre">long</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor10visit_boolEb">
<span id="_CPPv3N3fmt10ArgVisitor10visit_boolEb"></span><span id="_CPPv2N3fmt10ArgVisitor10visit_boolEb"></span><span id="fmt::ArgVisitor::visit_bool__b"></span><span class="target" id="classfmt_1_1_arg_visitor_1ad3013b580959ecbfaae97f29a35964ae"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_bool</code><span class="sig-paren">(</span>bool <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor10visit_boolEb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a <code class="docutils literal notranslate"><span class="pre">bool</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor10visit_charEi">
<span id="_CPPv3N3fmt10ArgVisitor10visit_charEi"></span><span id="_CPPv2N3fmt10ArgVisitor10visit_charEi"></span><span id="fmt::ArgVisitor::visit_char__i"></span><span class="target" id="classfmt_1_1_arg_visitor_1ad635596afa3cd1e4983db071f045dabd"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_char</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor10visit_charEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a <code class="docutils literal notranslate"><span class="pre">char</span></code> or <code class="docutils literal notranslate"><span class="pre">wchar_t</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4I0EN3fmt10ArgVisitor13visit_any_intE6Result1T">
<span id="_CPPv3I0EN3fmt10ArgVisitor13visit_any_intE1T"></span><span id="_CPPv2I0EN3fmt10ArgVisitor13visit_any_intE1T"></span>template<typename <code class="sig-name descname">T</code>><br /><span class="target" id="classfmt_1_1_arg_visitor_1a5e33c073c34ca49a6f1dd82181e2d98f"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_any_int</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt10ArgVisitor13visit_any_intE6Result1T" title="fmt::ArgVisitor::visit_any_int::T">T</a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN3fmt10ArgVisitor13visit_any_intE6Result1T" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits an argument of any integral type. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor12visit_doubleEd">
<span id="_CPPv3N3fmt10ArgVisitor12visit_doubleEd"></span><span id="_CPPv2N3fmt10ArgVisitor12visit_doubleEd"></span><span id="fmt::ArgVisitor::visit_double__double"></span><span class="target" id="classfmt_1_1_arg_visitor_1a2a7a4cbb1df7a8b3c310a607600773ae"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_double</code><span class="sig-paren">(</span>double <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor12visit_doubleEd" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a <code class="docutils literal notranslate"><span class="pre">double</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor17visit_long_doubleEe">
<span id="_CPPv3N3fmt10ArgVisitor17visit_long_doubleEe"></span><span id="_CPPv2N3fmt10ArgVisitor17visit_long_doubleEe"></span><span id="fmt::ArgVisitor::visit_long_double__l-double"></span><span class="target" id="classfmt_1_1_arg_visitor_1aa0b2e1792ff7e62d1a49a3118d3c10db"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_long_double</code><span class="sig-paren">(</span>long double <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor17visit_long_doubleEe" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a <code class="docutils literal notranslate"><span class="pre">long</span> <span class="pre">double</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4I0EN3fmt10ArgVisitor16visit_any_doubleE6Result1T">
<span id="_CPPv3I0EN3fmt10ArgVisitor16visit_any_doubleE1T"></span><span id="_CPPv2I0EN3fmt10ArgVisitor16visit_any_doubleE1T"></span>template<typename <code class="sig-name descname">T</code>><br /><span class="target" id="classfmt_1_1_arg_visitor_1a9a2cdc09adb9783cddb2548691e6720c"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_any_double</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt10ArgVisitor16visit_any_doubleE6Result1T" title="fmt::ArgVisitor::visit_any_double::T">T</a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN3fmt10ArgVisitor16visit_any_doubleE6Result1T" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a <code class="docutils literal notranslate"><span class="pre">double</span></code> or <code class="docutils literal notranslate"><span class="pre">long</span> <span class="pre">double</span></code> argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor13visit_cstringEPKc">
<span id="_CPPv3N3fmt10ArgVisitor13visit_cstringEPKc"></span><span id="_CPPv2N3fmt10ArgVisitor13visit_cstringEPKc"></span><span id="fmt::ArgVisitor::visit_cstring__cCP"></span><span class="target" id="classfmt_1_1_arg_visitor_1a6a91a7125820563502f1f5bb7a8c85be"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_cstring</code><span class="sig-paren">(</span><em class="property">const</em> char*<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor13visit_cstringEPKc" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a null-terminated C string (<code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">char</span> <span class="pre">*</span></code>) argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor12visit_stringEN3Arg11StringValueIcEE">
<span id="_CPPv3N3fmt10ArgVisitor12visit_stringEN3Arg11StringValueIcEE"></span><span id="_CPPv2N3fmt10ArgVisitor12visit_stringEN3Arg11StringValueIcEE"></span><span id="fmt::ArgVisitor::visit_string__Arg::StringValue:c:"></span><span class="target" id="classfmt_1_1_arg_visitor_1ac39e46583b36900aa8df8e533648cf99"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_string</code><span class="sig-paren">(</span>Arg::StringValue<char><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor12visit_stringEN3Arg11StringValueIcEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a string argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor13visit_wstringEN3Arg11StringValueIwEE">
<span id="_CPPv3N3fmt10ArgVisitor13visit_wstringEN3Arg11StringValueIwEE"></span><span id="_CPPv2N3fmt10ArgVisitor13visit_wstringEN3Arg11StringValueIwEE"></span><span id="fmt::ArgVisitor::visit_wstring__Arg::StringValue:wchar_t:"></span><span class="target" id="classfmt_1_1_arg_visitor_1abd76337375076717e6089763dcfb1ad0"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_wstring</code><span class="sig-paren">(</span>Arg::StringValue<wchar_t><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor13visit_wstringEN3Arg11StringValueIwEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a wide string argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor13visit_pointerEPKv">
<span id="_CPPv3N3fmt10ArgVisitor13visit_pointerEPKv"></span><span id="_CPPv2N3fmt10ArgVisitor13visit_pointerEPKv"></span><span id="fmt::ArgVisitor::visit_pointer__voidCP"></span><span class="target" id="classfmt_1_1_arg_visitor_1a80e62b2dcd7e7e38208a4863826ec731"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_pointer</code><span class="sig-paren">(</span><em class="property">const</em> void*<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor13visit_pointerEPKv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits a pointer argument. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor12visit_customEN3Arg11CustomValueE">
<span id="_CPPv3N3fmt10ArgVisitor12visit_customEN3Arg11CustomValueE"></span><span id="_CPPv2N3fmt10ArgVisitor12visit_customEN3Arg11CustomValueE"></span><span id="fmt::ArgVisitor::visit_custom__Arg::CustomValue"></span><span class="target" id="classfmt_1_1_arg_visitor_1a19a38c25e9c45f9c6a6674f7dfaf3759"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit_custom</code><span class="sig-paren">(</span>Arg::CustomValue<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor12visit_customEN3Arg11CustomValueE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Visits an argument of a custom (user-defined) type. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt10ArgVisitor5visitERK3Arg">
<span id="_CPPv3N3fmt10ArgVisitor5visitERK3Arg"></span><span id="_CPPv2N3fmt10ArgVisitor5visitERK3Arg"></span><span id="fmt::ArgVisitor::visit__ArgCR"></span><span class="target" id="classfmt_1_1_arg_visitor_1a19a979776fc789baaf038ab216e245bb"></span><a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor::Result">Result</a> <code class="sig-name descname">visit</code><span class="sig-paren">(</span><em class="property">const</em> Arg &<em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt10ArgVisitor5visitERK3Arg" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Visits an argument dispatching to the appropriate visit method based on
the argument type. For example, if the argument type is <code class="docutils literal notranslate"><span class="pre">double</span></code> then
the <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor12visit_doubleEd" title="fmt::ArgVisitor::visit_double"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_double()</span></code></a> method of the <em>Impl</em> class will be
called.</p>
</p>
</p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I000EN3fmt17BasicArgFormatterE">
<span id="_CPPv3I000EN3fmt17BasicArgFormatterE"></span><span id="_CPPv2I000EN3fmt17BasicArgFormatterE"></span>template<typename <code class="sig-name descname">Impl</code>, typename <code class="sig-name descname">Char</code>, typename <code class="sig-name descname">Spec</code> = fmt::FormatSpec><br /><span class="target" id="classfmt_1_1_basic_arg_formatter"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">BasicArgFormatter</code> : <em class="property">public</em> fmt::internal::ArgFormatterBase<<a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter::Impl">Impl</a>, <a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter::Char">Char</a>, fmt::FormatSpec><a class="headerlink" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>An argument formatter based on the <a class="reference external" href="http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern">curiously recurring template pattern</a>.</p>
<p>To use <a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">BasicArgFormatter</span></code></a> define a subclass that implements some or
all of the visit methods with the same signatures as the methods in
<a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ArgVisitor</span></code></a>, for example, <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor9visit_intEi" title="fmt::ArgVisitor::visit_int"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_int()</span></code></a>.
Pass the subclass as the <em>Impl</em> template parameter. When a formatting
function processes an argument, it will dispatch to a visit method
specific to the argument type. For example, if the argument type is
<code class="docutils literal notranslate"><span class="pre">double</span></code> then the <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor12visit_doubleEd" title="fmt::ArgVisitor::visit_double"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_double()</span></code></a> method of a subclass
will be called. If the subclass doesn’t contain a method with this signature,
then a corresponding method of <a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">BasicArgFormatter</span></code></a> or its superclass
will be called.</p>
</p>
</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt17BasicArgFormatter17BasicArgFormatterER14BasicFormatterI4Char4ImplER4SpecPK4Char">
<span id="_CPPv3N3fmt17BasicArgFormatter17BasicArgFormatterER14BasicFormatterI4Char4ImplER4SpecPK4Char"></span><span id="_CPPv2N3fmt17BasicArgFormatter17BasicArgFormatterER14BasicFormatterI4Char4ImplER4SpecPK4Char"></span><span id="fmt::BasicArgFormatter::BasicArgFormatter__BasicFormatter:Char.Impl:R.SpecR.CharCP"></span><span class="target" id="classfmt_1_1_basic_arg_formatter_1a9fbfaaf573b6714ed03894326b0a5106"></span><code class="sig-name descname">BasicArgFormatter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00EN3fmt14BasicFormatterE" title="fmt::BasicFormatter">BasicFormatter</a><<a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter::Char">Char</a>, <a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter::Impl">Impl</a>> &<em>formatter</em>, <a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter::Spec">Spec</a> &<em>spec</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter::Char">Char</a> *<em>fmt</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt17BasicArgFormatter17BasicArgFormatterER14BasicFormatterI4Char4ImplER4SpecPK4Char" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs an argument formatter object.
<em>formatter</em> is a reference to the main formatter object, <em>spec</em> contains
format specifier information for standard argument types, and <em>fmt</em> points
to the part of the format string being parsed for custom argument types.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt17BasicArgFormatter12visit_customEN8internal3Arg11CustomValueE">
<span id="_CPPv3N3fmt17BasicArgFormatter12visit_customEN8internal3Arg11CustomValueE"></span><span id="_CPPv2N3fmt17BasicArgFormatter12visit_customEN8internal3Arg11CustomValueE"></span><span id="fmt::BasicArgFormatter::visit_custom__internal::Arg::CustomValue"></span><span class="target" id="classfmt_1_1_basic_arg_formatter_1acc822e8efaa99b664deaf38b08950b88"></span>void <code class="sig-name descname">visit_custom</code><span class="sig-paren">(</span>internal::Arg::CustomValue <em>c</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt17BasicArgFormatter12visit_customEN8internal3Arg11CustomValueE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats an argument of a custom (user-defined) type. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I0EN3fmt12ArgFormatterE">
<span id="_CPPv3I0EN3fmt12ArgFormatterE"></span><span id="_CPPv2I0EN3fmt12ArgFormatterE"></span>template<typename <code class="sig-name descname">Char</code>><br /><span class="target" id="classfmt_1_1_arg_formatter"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">ArgFormatter</code> : <em class="property">public</em> fmt::<a class="reference internal" href="#_CPPv4I000EN3fmt17BasicArgFormatterE" title="fmt::BasicArgFormatter">BasicArgFormatter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt12ArgFormatterE" title="fmt::ArgFormatter">ArgFormatter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt12ArgFormatterE" title="fmt::ArgFormatter::Char">Char</a>>, <a class="reference internal" href="#_CPPv4I0EN3fmt12ArgFormatterE" title="fmt::ArgFormatter::Char">Char</a>, FormatSpec><a class="headerlink" href="#_CPPv4I0EN3fmt12ArgFormatterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The default argument formatter. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt12ArgFormatter12ArgFormatterER14BasicFormatterI4CharER10FormatSpecPK4Char">
<span id="_CPPv3N3fmt12ArgFormatter12ArgFormatterER14BasicFormatterI4CharER10FormatSpecPK4Char"></span><span id="_CPPv2N3fmt12ArgFormatter12ArgFormatterER14BasicFormatterI4CharER10FormatSpecPK4Char"></span><span id="fmt::ArgFormatter::ArgFormatter__BasicFormatter:Char:R.FormatSpecR.CharCP"></span><span class="target" id="classfmt_1_1_arg_formatter_1a2fc7b9c801f3aa33a8e952df035a140f"></span><code class="sig-name descname">ArgFormatter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00EN3fmt14BasicFormatterE" title="fmt::BasicFormatter">BasicFormatter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt12ArgFormatterE" title="fmt::ArgFormatter::Char">Char</a>> &<em>formatter</em>, FormatSpec &<em>spec</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv4I0EN3fmt12ArgFormatterE" title="fmt::ArgFormatter::Char">Char</a> *<em>fmt</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt12ArgFormatter12ArgFormatterER14BasicFormatterI4CharER10FormatSpecPK4Char" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructs an argument formatter object. </p>
</dd></dl>
</div>
</dd></dl>
</section>
<section id="printf-formatting">
<h3>Printf formatting<a class="headerlink" href="#printf-formatting" title="Permalink to this headline">¶</a></h3>
<p>The header <code class="docutils literal notranslate"><span class="pre">fmt/printf.h</span></code> provides <code class="docutils literal notranslate"><span class="pre">printf</span></code>-like formatting functionality.
The following functions use <a class="reference external" href="http://pubs.opengroup.org/onlinepubs/009695399/functions/fprintf.html">printf format string syntax</a> with
the POSIX extension for positional arguments. Unlike their standard
counterparts, the <code class="docutils literal notranslate"><span class="pre">fmt</span></code> functions are type-safe and throw an exception if an
argument type doesn’t match its format specification.</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt6printfE10CStringRef7ArgList">
<span id="_CPPv3N3fmt6printfE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt6printfE10CStringRef7ArgList"></span><span id="fmt::printf__CStringRef.ArgList"></span><span class="target" id="printf_8h_1aa936ffccf89f4609cd9fce18825f0b14"></span>int <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">printf</code><span class="sig-paren">(</span>CStringRef <em>format</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt6printfE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Prints formatted data to <code class="docutils literal notranslate"><span class="pre">stdout</span></code>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">fmt</span><span class="o">::</span><span class="n">printf</span><span class="p">(</span><span class="s">"Elapsed time: %.2f seconds"</span><span class="p">,</span><span class="w"> </span><span class="mf">1.23</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt7fprintfEPNSt4FILEE10CStringRef7ArgList">
<span id="_CPPv3N3fmt7fprintfEPNSt4FILEE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt7fprintfEPNSt4FILEE10CStringRef7ArgList"></span><span id="fmt::fprintf__std::FILEP.CStringRef.ArgList"></span><span class="target" id="printf_8h_1ae70c0a9615eef5e1e78450496d2a90e6"></span>int <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">fprintf</code><span class="sig-paren">(</span>std::FILE *<em>f</em>, CStringRef <em>format</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt7fprintfEPNSt4FILEE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Prints formatted data to the file <em>f</em>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">fmt</span><span class="o">::</span><span class="n">fprintf</span><span class="p">(</span><span class="n">stderr</span><span class="p">,</span><span class="w"> </span><span class="s">"Don't %s!"</span><span class="p">,</span><span class="w"> </span><span class="s">"panic"</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt7fprintfERNSt7ostreamE10CStringRef7ArgList">
<span id="_CPPv3N3fmt7fprintfERNSt7ostreamE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt7fprintfERNSt7ostreamE10CStringRef7ArgList"></span><span id="fmt::fprintf__osR.CStringRef.ArgList"></span><span class="target" id="printf_8h_1adf9e00e4ddf5cad224a101333cfac9e8"></span>int <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">fprintf</code><span class="sig-paren">(</span>std::ostream &<em>os</em>, CStringRef <em>format_str</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt7fprintfERNSt7ostreamE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Prints formatted data to the stream <em>os</em>.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">fprintf</span><span class="p">(</span><span class="n">cerr</span><span class="p">,</span><span class="w"> </span><span class="s">"Don't %s!"</span><span class="p">,</span><span class="w"> </span><span class="s">"panic"</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt7sprintfE10CStringRef7ArgList">
<span id="_CPPv3N3fmt7sprintfE10CStringRef7ArgList"></span><span id="_CPPv2N3fmt7sprintfE10CStringRef7ArgList"></span><span id="fmt::sprintf__CStringRef.ArgList"></span><span class="target" id="printf_8h_1a956d655d1291fb85203c58fadd4bba1a"></span>std::string <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">sprintf</code><span class="sig-paren">(</span>CStringRef <em>format</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt7sprintfE10CStringRef7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Formats arguments and returns the result as a string.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">fmt</span><span class="o">::</span><span class="n">sprintf</span><span class="p">(</span><span class="s">"The answer is %d"</span><span class="p">,</span><span class="w"> </span><span class="mi">42</span><span class="p">);</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I00EN3fmt15PrintfFormatterE">
<span id="_CPPv3I00EN3fmt15PrintfFormatterE"></span><span id="_CPPv2I00EN3fmt15PrintfFormatterE"></span>template<typename <code class="sig-name descname">Char</code>, typename <code class="sig-name descname">ArgFormatter</code> = <a class="reference internal" href="#_CPPv4I0EN3fmt18PrintfArgFormatterE" title="fmt::PrintfArgFormatter">PrintfArgFormatter</a><<a class="reference internal" href="#_CPPv4I00EN3fmt15PrintfFormatterE" title="fmt::PrintfFormatter::Char">Char</a>>><br /><span class="target" id="classfmt_1_1_printf_formatter"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">PrintfFormatter</code> : <em class="property">private</em> fmt::internal::FormatterBase<a class="headerlink" href="#_CPPv4I00EN3fmt15PrintfFormatterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>This template formats data and writes the output to a writer. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt15PrintfFormatter15PrintfFormatterERK7ArgListR11BasicWriterI4CharE">
<span id="_CPPv3N3fmt15PrintfFormatter15PrintfFormatterERK7ArgListR11BasicWriterI4CharE"></span><span id="_CPPv2N3fmt15PrintfFormatter15PrintfFormatterERK7ArgListR11BasicWriterI4CharE"></span><span id="fmt::PrintfFormatter::PrintfFormatter__ArgListCR.BasicWriter:Char:R"></span><span class="target" id="classfmt_1_1_printf_formatter_1a9cb3cad9a8e4cd08445e9ff2338d40b0"></span><code class="sig-name descname">PrintfFormatter</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> &<em>al</em>, <a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4I00EN3fmt15PrintfFormatterE" title="fmt::PrintfFormatter::Char">Char</a>> &<em>w</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt15PrintfFormatter15PrintfFormatterERK7ArgListR11BasicWriterI4CharE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs a <code class="docutils literal notranslate"><span class="pre">PrintfFormatter</span></code> object. References to the arguments and
the writer are stored in the formatter object so make sure they have
appropriate lifetimes.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt15PrintfFormatter6formatE15BasicCStringRefI4CharE">
<span id="_CPPv3N3fmt15PrintfFormatter6formatE15BasicCStringRefI4CharE"></span><span id="_CPPv2N3fmt15PrintfFormatter6formatE15BasicCStringRefI4CharE"></span><span id="fmt::PrintfFormatter::format__BasicCStringRef:Char:"></span><span class="target" id="classfmt_1_1_printf_formatter_1a295c50e11b9a77720c8078f287040e5c"></span>void <code class="sig-name descname">format</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt15BasicCStringRefE" title="fmt::BasicCStringRef">BasicCStringRef</a><<a class="reference internal" href="#_CPPv4I00EN3fmt15PrintfFormatterE" title="fmt::PrintfFormatter::Char">Char</a>> <em>format_str</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt15PrintfFormatter6formatE15BasicCStringRefI4CharE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats stored arguments and writes the output to the writer. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I000EN3fmt23BasicPrintfArgFormatterE">
<span id="_CPPv3I000EN3fmt23BasicPrintfArgFormatterE"></span><span id="_CPPv2I000EN3fmt23BasicPrintfArgFormatterE"></span>template<typename <code class="sig-name descname">Impl</code>, typename <code class="sig-name descname">Char</code>, typename <code class="sig-name descname">Spec</code>><br /><span class="target" id="classfmt_1_1_basic_printf_arg_formatter"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">BasicPrintfArgFormatter</code> : <em class="property">public</em> fmt::internal::ArgFormatterBase<<a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter::Impl">Impl</a>, <a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter::Char">Char</a>, <a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter::Spec">Spec</a>><a class="headerlink" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>A <code class="docutils literal notranslate"><span class="pre">printf</span></code> argument formatter based on the <a class="reference external" href="http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern">curiously recurring template
pattern</a>.</p>
<p>To use <a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">BasicPrintfArgFormatter</span></code></a> define a subclass that implements some
or all of the visit methods with the same signatures as the methods in
<a class="reference internal" href="#_CPPv4I00EN3fmt10ArgVisitorE" title="fmt::ArgVisitor"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ArgVisitor</span></code></a>, for example, <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor9visit_intEi" title="fmt::ArgVisitor::visit_int"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_int()</span></code></a>.
Pass the subclass as the <em>Impl</em> template parameter. When a formatting
function processes an argument, it will dispatch to a visit method
specific to the argument type. For example, if the argument type is
<code class="docutils literal notranslate"><span class="pre">double</span></code> then the <a class="reference internal" href="#_CPPv4N3fmt10ArgVisitor12visit_doubleEd" title="fmt::ArgVisitor::visit_double"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">visit_double()</span></code></a> method of a subclass
will be called. If the subclass doesn’t contain a method with this signature,
then a corresponding method of <a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">BasicPrintfArgFormatter</span></code></a> or its
superclass will be called.</p>
</p>
</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt23BasicPrintfArgFormatter23BasicPrintfArgFormatterER11BasicWriterI4CharER4Spec">
<span id="_CPPv3N3fmt23BasicPrintfArgFormatter23BasicPrintfArgFormatterER11BasicWriterI4CharER4Spec"></span><span id="_CPPv2N3fmt23BasicPrintfArgFormatter23BasicPrintfArgFormatterER11BasicWriterI4CharER4Spec"></span><span id="fmt::BasicPrintfArgFormatter::BasicPrintfArgFormatter__BasicWriter:Char:R.SpecR"></span><span class="target" id="classfmt_1_1_basic_printf_arg_formatter_1a7027cf03f0a54f8d7e53563e948d9f54"></span><code class="sig-name descname">BasicPrintfArgFormatter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter::Char">Char</a>> &<em>w</em>, <a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter::Spec">Spec</a> &<em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt23BasicPrintfArgFormatter23BasicPrintfArgFormatterER11BasicWriterI4CharER4Spec" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs an argument formatter object.
<em>writer</em> is a reference to the output writer and <em>spec</em> contains format
specifier information for standard argument types.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt23BasicPrintfArgFormatter10visit_boolEb">
<span id="_CPPv3N3fmt23BasicPrintfArgFormatter10visit_boolEb"></span><span id="_CPPv2N3fmt23BasicPrintfArgFormatter10visit_boolEb"></span><span id="fmt::BasicPrintfArgFormatter::visit_bool__b"></span><span class="target" id="classfmt_1_1_basic_printf_arg_formatter_1a5a8896e3b7e60b678ad7ac1145d2d7db"></span>void <code class="sig-name descname">visit_bool</code><span class="sig-paren">(</span>bool <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt23BasicPrintfArgFormatter10visit_boolEb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats an argument of type <code class="docutils literal notranslate"><span class="pre">bool</span></code>. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt23BasicPrintfArgFormatter10visit_charEi">
<span id="_CPPv3N3fmt23BasicPrintfArgFormatter10visit_charEi"></span><span id="_CPPv2N3fmt23BasicPrintfArgFormatter10visit_charEi"></span><span id="fmt::BasicPrintfArgFormatter::visit_char__i"></span><span class="target" id="classfmt_1_1_basic_printf_arg_formatter_1a6d6a9710fe756a8682efa6e83eea8146"></span>void <code class="sig-name descname">visit_char</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt23BasicPrintfArgFormatter10visit_charEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats a character. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt23BasicPrintfArgFormatter13visit_cstringEPKc">
<span id="_CPPv3N3fmt23BasicPrintfArgFormatter13visit_cstringEPKc"></span><span id="_CPPv2N3fmt23BasicPrintfArgFormatter13visit_cstringEPKc"></span><span id="fmt::BasicPrintfArgFormatter::visit_cstring__cCP"></span><span class="target" id="classfmt_1_1_basic_printf_arg_formatter_1a202e5093c8d7ab388c05f58956e8f721"></span>void <code class="sig-name descname">visit_cstring</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt23BasicPrintfArgFormatter13visit_cstringEPKc" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats a null-terminated C string. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt23BasicPrintfArgFormatter13visit_pointerEPKv">
<span id="_CPPv3N3fmt23BasicPrintfArgFormatter13visit_pointerEPKv"></span><span id="_CPPv2N3fmt23BasicPrintfArgFormatter13visit_pointerEPKv"></span><span id="fmt::BasicPrintfArgFormatter::visit_pointer__voidCP"></span><span class="target" id="classfmt_1_1_basic_printf_arg_formatter_1a4184ac39a994f38d4b4850393e413a1c"></span>void <code class="sig-name descname">visit_pointer</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt23BasicPrintfArgFormatter13visit_pointerEPKv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats a pointer. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt23BasicPrintfArgFormatter12visit_customEN8internal3Arg11CustomValueE">
<span id="_CPPv3N3fmt23BasicPrintfArgFormatter12visit_customEN8internal3Arg11CustomValueE"></span><span id="_CPPv2N3fmt23BasicPrintfArgFormatter12visit_customEN8internal3Arg11CustomValueE"></span><span id="fmt::BasicPrintfArgFormatter::visit_custom__internal::Arg::CustomValue"></span><span class="target" id="classfmt_1_1_basic_printf_arg_formatter_1a5ad1e99dfd69b88a6b7940c1bfc52d23"></span>void <code class="sig-name descname">visit_custom</code><span class="sig-paren">(</span>internal::Arg::CustomValue <em>c</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt23BasicPrintfArgFormatter12visit_customEN8internal3Arg11CustomValueE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Formats an argument of a custom (user-defined) type. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I0EN3fmt18PrintfArgFormatterE">
<span id="_CPPv3I0EN3fmt18PrintfArgFormatterE"></span><span id="_CPPv2I0EN3fmt18PrintfArgFormatterE"></span>template<typename <code class="sig-name descname">Char</code>><br /><span class="target" id="classfmt_1_1_printf_arg_formatter"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">PrintfArgFormatter</code> : <em class="property">public</em> fmt::<a class="reference internal" href="#_CPPv4I000EN3fmt23BasicPrintfArgFormatterE" title="fmt::BasicPrintfArgFormatter">BasicPrintfArgFormatter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt18PrintfArgFormatterE" title="fmt::PrintfArgFormatter">PrintfArgFormatter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt18PrintfArgFormatterE" title="fmt::PrintfArgFormatter::Char">Char</a>>, <a class="reference internal" href="#_CPPv4I0EN3fmt18PrintfArgFormatterE" title="fmt::PrintfArgFormatter::Char">Char</a>, FormatSpec><a class="headerlink" href="#_CPPv4I0EN3fmt18PrintfArgFormatterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The default printf argument formatter. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt18PrintfArgFormatter18PrintfArgFormatterER11BasicWriterI4CharER10FormatSpec">
<span id="_CPPv3N3fmt18PrintfArgFormatter18PrintfArgFormatterER11BasicWriterI4CharER10FormatSpec"></span><span id="_CPPv2N3fmt18PrintfArgFormatter18PrintfArgFormatterER11BasicWriterI4CharER10FormatSpec"></span><span id="fmt::PrintfArgFormatter::PrintfArgFormatter__BasicWriter:Char:R.FormatSpecR"></span><span class="target" id="classfmt_1_1_printf_arg_formatter_1aa4b9526d3c614205d607f63918c33245"></span><code class="sig-name descname">PrintfArgFormatter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt18PrintfArgFormatterE" title="fmt::PrintfArgFormatter::Char">Char</a>> &<em>w</em>, FormatSpec &<em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt18PrintfArgFormatter18PrintfArgFormatterER11BasicWriterI4CharER10FormatSpec" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructs an argument formatter object. </p>
</dd></dl>
</div>
</dd></dl>
</section>
</section>
<section id="write-api">
<h2>Write API<a class="headerlink" href="#write-api" title="Permalink to this headline">¶</a></h2>
<p>The write API provides classes for writing formatted data into character
streams. It is usually faster than the <a class="reference internal" href="#format-api">format API</a> but, as IOStreams,
may result in larger compiled code size. The main writer class is
<a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">BasicMemoryWriter</span></code></a> which stores its output in a memory buffer and
provides direct access to it. It is possible to create custom writers that
store output elsewhere by subclassing <a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">BasicWriter</span></code></a>.</p>
<dl class="cpp class">
<dt id="_CPPv4I0EN3fmt11BasicWriterE">
<span id="_CPPv3I0EN3fmt11BasicWriterE"></span><span id="_CPPv2I0EN3fmt11BasicWriterE"></span>template<typename <code class="sig-name descname">Char</code>><br /><span class="target" id="classfmt_1_1_basic_writer"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">BasicWriter</code><a class="headerlink" href="#_CPPv4I0EN3fmt11BasicWriterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>This template provides operations for formatting and writing data into
a character stream. The output is stored in a buffer provided by a subclass
such as <a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">fmt::BasicMemoryWriter</span></code></a>.</p>
<p>You can use one of the following typedefs for common character types:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 29%" />
<col style="width: 71%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Definition</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Writer</p></td>
<td><p>BasicWriter<char></p></td>
</tr>
<tr class="row-odd"><td><p>WWriter</p></td>
<td><p>BasicWriter<wchar_t></p></td>
</tr>
</tbody>
</table>
</p>
</p>
<p>Subclassed by <a class="reference internal" href="#classfmt_1_1_basic_array_writer"><span class="std std-ref">fmt::BasicArrayWriter< Char ></span></a>, <a class="reference internal" href="#classfmt_1_1_basic_memory_writer"><span class="std std-ref">fmt::BasicMemoryWriter< Char, Allocator ></span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt11BasicWriterD0Ev">
<span id="_CPPv3N3fmt11BasicWriterD0Ev"></span><span id="_CPPv2N3fmt11BasicWriterD0Ev"></span><span id="fmt::BasicWriter::~BasicWriter"></span><span class="target" id="classfmt_1_1_basic_writer_1a25f6fc2e43d3bcfb3de9ac33afe6050d"></span><code class="sig-name descname">~BasicWriter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt11BasicWriterD0Ev" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Destroys a <code class="docutils literal notranslate"><span class="pre">BasicWriter</span></code> object.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4NK3fmt11BasicWriter4sizeEv">
<span id="_CPPv3NK3fmt11BasicWriter4sizeEv"></span><span id="_CPPv2NK3fmt11BasicWriter4sizeEv"></span><span id="fmt::BasicWriter::sizeC"></span><span class="target" id="classfmt_1_1_basic_writer_1a8d4534eea273ef4a3dd9078b995d3d15"></span>std::size_t <code class="sig-name descname">size</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK3fmt11BasicWriter4sizeEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns the total number of characters written. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4NK3fmt11BasicWriter4dataEv">
<span id="_CPPv3NK3fmt11BasicWriter4dataEv"></span><span id="_CPPv2NK3fmt11BasicWriter4dataEv"></span><span id="fmt::BasicWriter::dataC"></span><span class="target" id="classfmt_1_1_basic_writer_1ab7c743a96b3c86f60d880101609024ab"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter::Char">Char</a> *<code class="sig-name descname">data</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK3fmt11BasicWriter4dataEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns a pointer to the output buffer content. </p>
<p>No terminating null character is appended. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4NK3fmt11BasicWriter5c_strEv">
<span id="_CPPv3NK3fmt11BasicWriter5c_strEv"></span><span id="_CPPv2NK3fmt11BasicWriter5c_strEv"></span><span id="fmt::BasicWriter::c_strC"></span><span class="target" id="classfmt_1_1_basic_writer_1af4d05efd5e2f4390baaad0da402dd430"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter::Char">Char</a> *<code class="sig-name descname">c_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK3fmt11BasicWriter5c_strEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns a pointer to the output buffer content with terminating null character appended. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4NK3fmt11BasicWriter3strEv">
<span id="_CPPv3NK3fmt11BasicWriter3strEv"></span><span id="_CPPv2NK3fmt11BasicWriter3strEv"></span><span id="fmt::BasicWriter::strC"></span><span class="target" id="classfmt_1_1_basic_writer_1aa20ff30071101e787d890ff957e481d5"></span>std::basic_string<<a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter::Char">Char</a>> <code class="sig-name descname">str</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv4NK3fmt11BasicWriter3strEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Returns the content of the output buffer as an <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">std::string</span></code>.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt11BasicWriter5writeE15BasicCStringRefI4CharE7ArgList">
<span id="_CPPv3N3fmt11BasicWriter5writeE15BasicCStringRefI4CharE7ArgList"></span><span id="_CPPv2N3fmt11BasicWriter5writeE15BasicCStringRefI4CharE7ArgList"></span><span id="fmt::BasicWriter::write__BasicCStringRef:Char:.ArgList"></span><span class="target" id="classfmt_1_1_basic_writer_1aaa83498c649d4a90ea3366bae62f4eac"></span>void <code class="sig-name descname">write</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt15BasicCStringRefE" title="fmt::BasicCStringRef">BasicCStringRef</a><<a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter::Char">Char</a>> <em>format</em>, <a class="reference internal" href="#_CPPv4N3fmt7ArgListE" title="fmt::ArgList">ArgList</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt11BasicWriter5writeE15BasicCStringRefI4CharE7ArgList" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Writes formatted data.</p>
<p><em>args</em> is an argument list representing arbitrary arguments.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">MemoryWriter</span><span class="w"> </span><span class="n">out</span><span class="p">;</span>
<span class="n">out</span><span class="p">.</span><span class="n">write</span><span class="p">(</span><span class="s">"Current point:</span><span class="se">\n</span><span class="s">"</span><span class="p">);</span>
<span class="n">out</span><span class="p">.</span><span class="n">write</span><span class="p">(</span><span class="s">"({:+f}, {:+f})"</span><span class="p">,</span><span class="w"> </span><span class="mf">-3.14</span><span class="p">,</span><span class="w"> </span><span class="mf">3.14</span><span class="p">);</span>
</pre></div>
</div>
<p>This will write the following output to the <code class="docutils literal notranslate"><span class="pre">out</span></code> object:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Current point:
(-3.140000, +3.140000)
</pre></div>
</div>
<p>The output can be accessed using <a class="reference internal" href="#_CPPv4NK3fmt11BasicWriter4dataEv" title="fmt::BasicWriter::data"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">data()</span></code></a>, <a class="reference internal" href="#_CPPv4NK3fmt11BasicWriter5c_strEv" title="fmt::BasicWriter::c_str"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">c_str()</span></code></a> or
<a class="reference internal" href="#_CPPv4NK3fmt11BasicWriter3strEv" title="fmt::BasicWriter::str"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">str()</span></code></a> methods.</p>
<p>See also <a class="reference internal" href="syntax.html#syntax"><span class="std std-ref">Format String Syntax</span></a>.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt11BasicWriterlsE9ULongLong">
<span id="_CPPv3N3fmt11BasicWriterlsE9ULongLong"></span><span id="_CPPv2N3fmt11BasicWriterlsE9ULongLong"></span><span id="fmt::BasicWriter::lshift-operator__ULongLong"></span><span class="target" id="classfmt_1_1_basic_writer_1afe43e2211f482ea3c5fe275b0ed83516"></span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a> &<code class="sig-name descname">operator<<</code><span class="sig-paren">(</span>ULongLong <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt11BasicWriterlsE9ULongLong" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Formats <em>value</em> and writes it to the stream.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt11BasicWriterlsEe">
<span id="_CPPv3N3fmt11BasicWriterlsEe"></span><span id="_CPPv2N3fmt11BasicWriterlsEe"></span><span id="fmt::BasicWriter::lshift-operator__l-double"></span><span class="target" id="classfmt_1_1_basic_writer_1a43b511b16037dc05ff54351e5de847ce"></span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a> &<code class="sig-name descname">operator<<</code><span class="sig-paren">(</span>long double <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt11BasicWriterlsEe" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Formats <em>value</em> using the general format for floating-point numbers
(<code class="docutils literal notranslate"><span class="pre">'g'</span></code>) and writes it to the stream.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt11BasicWriterlsEc">
<span id="_CPPv3N3fmt11BasicWriterlsEc"></span><span id="_CPPv2N3fmt11BasicWriterlsEc"></span><span id="fmt::BasicWriter::lshift-operator__c"></span><span class="target" id="classfmt_1_1_basic_writer_1a826d6661caf02200e341294e5fd921c2"></span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a> &<code class="sig-name descname">operator<<</code><span class="sig-paren">(</span>char <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt11BasicWriterlsEc" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Writes a character to the stream. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt11BasicWriterlsEN3fmt14BasicStringRefI4CharEE">
<span id="_CPPv3N3fmt11BasicWriterlsEN3fmt14BasicStringRefI4CharEE"></span><span id="_CPPv2N3fmt11BasicWriterlsEN3fmt14BasicStringRefI4CharEE"></span><span id="fmt::BasicWriter::lshift-operator__fmt::BasicStringRef:Char:"></span><span class="target" id="classfmt_1_1_basic_writer_1a7236c832b0958e35e062f301c73478a7"></span><a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a> &<code class="sig-name descname">operator<<</code><span class="sig-paren">(</span>fmt::<a class="reference internal" href="#_CPPv4I0EN3fmt14BasicStringRefE" title="fmt::BasicStringRef">BasicStringRef</a><<a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter::Char">Char</a>> <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt11BasicWriterlsEN3fmt14BasicStringRefI4CharEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Writes <em>value</em> to the stream.</p>
</p>
</p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I00EN3fmt17BasicMemoryWriterE">
<span id="_CPPv3I00EN3fmt17BasicMemoryWriterE"></span><span id="_CPPv2I00EN3fmt17BasicMemoryWriterE"></span>template<typename <code class="sig-name descname">Char</code>, typename <code class="sig-name descname">Allocator</code> = std::allocator<<a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter::Char">Char</a>>><br /><span class="target" id="classfmt_1_1_basic_memory_writer"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">BasicMemoryWriter</code> : <em class="property">public</em> fmt::<a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter::Char">Char</a>><a class="headerlink" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>This class template provides operations for formatting and writing data
into a character stream. The output is stored in a memory buffer that grows
dynamically.</p>
<p>You can use one of the following typedefs for common character types
and the standard allocator:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 78%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Definition</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>MemoryWriter</p></td>
<td><p>BasicMemoryWriter<char, std::allocator<char>></p></td>
</tr>
<tr class="row-odd"><td><p>WMemoryWriter</p></td>
<td><p>BasicMemoryWriter<wchar_t, std::allocator<wchar_t>></p></td>
</tr>
</tbody>
</table>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">MemoryWriter</span><span class="w"> </span><span class="n">out</span><span class="p">;</span>
<span class="n">out</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"The answer is "</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="n">out</span><span class="p">.</span><span class="n">write</span><span class="p">(</span><span class="s">"({:+f}, {:+f})"</span><span class="p">,</span><span class="w"> </span><span class="mf">-3.14</span><span class="p">,</span><span class="w"> </span><span class="mf">3.14</span><span class="p">);</span>
</pre></div>
</div>
<p>This will write the following output to the <code class="docutils literal notranslate"><span class="pre">out</span></code> object:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>The answer is 42
(-3.140000, +3.140000)
</pre></div>
</div>
<p>The output can be converted to an <code class="docutils literal notranslate"><span class="pre">std::string</span></code> with <code class="docutils literal notranslate"><span class="pre">out.str()</span></code> or
accessed as a C string with <code class="docutils literal notranslate"><span class="pre">out.c_str()</span></code>.</p>
</p>
</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt17BasicMemoryWriter17BasicMemoryWriterERR17BasicMemoryWriter">
<span id="_CPPv3N3fmt17BasicMemoryWriter17BasicMemoryWriterERR17BasicMemoryWriter"></span><span id="_CPPv2N3fmt17BasicMemoryWriter17BasicMemoryWriterERR17BasicMemoryWriter"></span><span id="fmt::BasicMemoryWriter::BasicMemoryWriter__BasicMemoryWriterRR"></span><span class="target" id="classfmt_1_1_basic_memory_writer_1a245047763a93566d0a7c1f90e8901672"></span><code class="sig-name descname">BasicMemoryWriter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N3fmt17BasicMemoryWriter17BasicMemoryWriterERR17BasicMemoryWriter" title="fmt::BasicMemoryWriter::BasicMemoryWriter">BasicMemoryWriter</a> &&<em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt17BasicMemoryWriter17BasicMemoryWriterERR17BasicMemoryWriter" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs a <a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">fmt::BasicMemoryWriter</span></code></a> object moving the content
of the other object to it.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt17BasicMemoryWriteraSERR17BasicMemoryWriter">
<span id="_CPPv3N3fmt17BasicMemoryWriteraSERR17BasicMemoryWriter"></span><span id="_CPPv2N3fmt17BasicMemoryWriteraSERR17BasicMemoryWriter"></span><span id="fmt::BasicMemoryWriter::assign-operator__BasicMemoryWriterRR"></span><span class="target" id="classfmt_1_1_basic_memory_writer_1a2b8ad6d2a380437bc9252532051b959d"></span><a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter">BasicMemoryWriter</a> &<code class="sig-name descname">operator=</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter">BasicMemoryWriter</a> &&<em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt17BasicMemoryWriteraSERR17BasicMemoryWriter" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Moves the content of the other <code class="docutils literal notranslate"><span class="pre">BasicMemoryWriter</span></code> object to this one.</p>
</p>
</p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv4I0EN3fmt16BasicArrayWriterE">
<span id="_CPPv3I0EN3fmt16BasicArrayWriterE"></span><span id="_CPPv2I0EN3fmt16BasicArrayWriterE"></span>template<typename <code class="sig-name descname">Char</code>><br /><span class="target" id="classfmt_1_1_basic_array_writer"></span><em class="property">class </em><code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">BasicArrayWriter</code> : <em class="property">public</em> fmt::<a class="reference internal" href="#_CPPv4I0EN3fmt11BasicWriterE" title="fmt::BasicWriter">BasicWriter</a><<a class="reference internal" href="#_CPPv4I0EN3fmt16BasicArrayWriterE" title="fmt::BasicArrayWriter::Char">Char</a>><a class="headerlink" href="#_CPPv4I0EN3fmt16BasicArrayWriterE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>This class template provides operations for formatting and writing data
into a fixed-size array. For writing into a dynamically growing buffer
use <a class="reference internal" href="#_CPPv4I00EN3fmt17BasicMemoryWriterE" title="fmt::BasicMemoryWriter"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">fmt::BasicMemoryWriter</span></code></a>.</p>
<p>Any write method will throw <code class="docutils literal notranslate"><span class="pre">std::runtime_error</span></code> if the output doesn’t fit
into the array.</p>
<p>You can use one of the following typedefs for common character types:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 34%" />
<col style="width: 66%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Definition</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>ArrayWriter</p></td>
<td><p>BasicArrayWriter<char></p></td>
</tr>
<tr class="row-odd"><td><p>WArrayWriter</p></td>
<td><p>BasicArrayWriter<wchar_t></p></td>
</tr>
</tbody>
</table>
</p>
</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N3fmt16BasicArrayWriter16BasicArrayWriterEP4CharNSt6size_tE">
<span id="_CPPv3N3fmt16BasicArrayWriter16BasicArrayWriterEP4CharNSt6size_tE"></span><span id="_CPPv2N3fmt16BasicArrayWriter16BasicArrayWriterEP4CharNSt6size_tE"></span><span id="fmt::BasicArrayWriter::BasicArrayWriter__CharP.std::s"></span><span class="target" id="classfmt_1_1_basic_array_writer_1a7559ecce2ffb3ecbb275dac5d2cc05e9"></span><code class="sig-name descname">BasicArrayWriter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt16BasicArrayWriterE" title="fmt::BasicArrayWriter::Char">Char</a> *<em>array</em>, std::size_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt16BasicArrayWriter16BasicArrayWriterEP4CharNSt6size_tE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs a <a class="reference internal" href="#_CPPv4I0EN3fmt16BasicArrayWriterE" title="fmt::BasicArrayWriter"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">fmt::BasicArrayWriter</span></code></a> object for <em>array</em> of the
given size.</p>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4I_NSt6size_tEEN3fmt16BasicArrayWriter16BasicArrayWriterERA4SIZE_4Char">
<span id="_CPPv3I_NSt6size_tEEN3fmt16BasicArrayWriter16BasicArrayWriterERA4SIZE_4Char"></span><span id="_CPPv2I_NSt6size_tEEN3fmt16BasicArrayWriter16BasicArrayWriterERASIZE_4Char"></span>template<std::size_t <code class="sig-name descname">SIZE</code>><br /><span class="target" id="classfmt_1_1_basic_array_writer_1ab8787cfc9b1500c0f2765074f64e5088"></span><code class="sig-name descname">BasicArrayWriter</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN3fmt16BasicArrayWriterE" title="fmt::BasicArrayWriter::Char">Char</a> (&<em>array</em>)[SIZE]<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I_NSt6size_tEEN3fmt16BasicArrayWriter16BasicArrayWriterERA4SIZE_4Char" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Constructs a <a class="reference internal" href="#_CPPv4I0EN3fmt16BasicArrayWriterE" title="fmt::BasicArrayWriter"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">fmt::BasicArrayWriter</span></code></a> object for <em>array</em> of the
size known at compile time.</p>
</p>
</p>
</dd></dl>
</div>
</dd></dl>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>doxygenclass: Cannot find class “fmt::BasicStringWriter” in doxygen xml output for project “format” from directory: /Users/viz/work/fmt/support/build/doxyxml</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>doxygenclass: Cannot find class “fmt::BasicContainerWriter” in doxygen xml output for project “format” from directory: /Users/viz/work/fmt/support/build/doxyxml</p>
</div>
<dl class="cpp function">
<dt id="_CPPv4N3fmt3binEi">
<span id="_CPPv3N3fmt3binEi"></span><span id="_CPPv2N3fmt3binEi"></span><span id="fmt::bin__i"></span><span class="target" id="format_8h_1a760fce6f0963895343b50eec787f80db"></span>IntFormatSpec<int, TypeSpec<'b'>> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">bin</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt3binEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns an integer format specifier to format the value in base 2. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt3octEi">
<span id="_CPPv3N3fmt3octEi"></span><span id="_CPPv2N3fmt3octEi"></span><span id="fmt::oct__i"></span><span class="target" id="format_8h_1a49d07603108a758be5cc6157f456e32d"></span>IntFormatSpec<int, TypeSpec<'o'>> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">oct</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt3octEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns an integer format specifier to format the value in base 8. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt3hexEi">
<span id="_CPPv3N3fmt3hexEi"></span><span id="_CPPv2N3fmt3hexEi"></span><span id="fmt::hex__i"></span><span class="target" id="format_8h_1a8451bad40c90c2ce2aa1a932851cf090"></span>IntFormatSpec<int, TypeSpec<'x'>> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">hex</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt3hexEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns an integer format specifier to format the value in base 16 using lower-case letters for the digits above 9. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmt4hexuEi">
<span id="_CPPv3N3fmt4hexuEi"></span><span id="_CPPv2N3fmt4hexuEi"></span><span id="fmt::hexu__i"></span><span class="target" id="format_8h_1ae08e783a599e0667dae7b5a63a265de4"></span>IntFormatSpec<int, TypeSpec<'X'>> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">hexu</code><span class="sig-paren">(</span>int <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt4hexuEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns an integer formatter format specifier to format in base 16 using upper-case letters for the digits above 9. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4I_c0EN3fmt3padE13IntFormatSpecIi13AlignTypeSpecI9TYPE_CODEE4CharEij4Char">
<span id="_CPPv3I_c0EN3fmt3padEij4Char"></span><span id="_CPPv2I_c0EN3fmt3padEij4Char"></span>template<char <code class="sig-name descname">TYPE_CODE</code>, typename <code class="sig-name descname">Char</code>><br /><span class="target" id="format_8h_1ad4b6754cf3790b562ea3bcc2faff5dd2"></span>IntFormatSpec<int, AlignTypeSpec<<a class="reference internal" href="#_CPPv4I_c0EN3fmt3padE13IntFormatSpecIi13AlignTypeSpecI9TYPE_CODEE4CharEij4Char" title="fmt::pad::TYPE_CODE">TYPE_CODE</a>>, <a class="reference internal" href="#_CPPv4I_c0EN3fmt3padE13IntFormatSpecIi13AlignTypeSpecI9TYPE_CODEE4CharEij4Char" title="fmt::pad::Char">Char</a>> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">pad</code><span class="sig-paren">(</span>int <em>value</em>, unsigned <em>width</em>, <a class="reference internal" href="#_CPPv4I_c0EN3fmt3padE13IntFormatSpecIi13AlignTypeSpecI9TYPE_CODEE4CharEij4Char" title="fmt::pad::Char">Char</a> <em>fill</em> = ' '<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I_c0EN3fmt3padE13IntFormatSpecIi13AlignTypeSpecI9TYPE_CODEE4CharEij4Char" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Returns an integer format specifier to pad the formatted argument with the
fill character to the specified width using the default (right) numeric
alignment.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">MemoryWriter</span><span class="w"> </span><span class="n">out</span><span class="p">;</span>
<span class="n">out</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">pad</span><span class="p">(</span><span class="n">hex</span><span class="p">(</span><span class="mh">0xcafe</span><span class="p">),</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w"> </span><span class="sc">'0'</span><span class="p">);</span>
<span class="c1">// out.str() == "0000cafe"</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
</section>
<section id="utilities">
<h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h2>
<dl class="cpp function">
<dt id="_CPPv4I0EN3fmt3argEN8internal16NamedArgWithTypeIc1TEE9StringRefRK1T">
<span id="_CPPv3I0EN3fmt3argE9StringRefRK1T"></span><span id="_CPPv2I0EN3fmt3argE9StringRefRK1T"></span>template<typename <code class="sig-name descname">T</code>><br /><span class="target" id="format_8h_1ad3e8553a35ec0e243bce6a0d0a805bcd"></span>internal::NamedArgWithType<char, <a class="reference internal" href="#_CPPv4I0EN3fmt3argEN8internal16NamedArgWithTypeIc1TEE9StringRefRK1T" title="fmt::arg::T">T</a>> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">arg</code><span class="sig-paren">(</span>StringRef <em>name</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv4I0EN3fmt3argEN8internal16NamedArgWithTypeIc1TEE9StringRefRK1T" title="fmt::arg::T">T</a> &<em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN3fmt3argEN8internal16NamedArgWithTypeIc1TEE9StringRefRK1T" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>Returns a named argument for formatting functions.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">print</span><span class="p">(</span><span class="s">"Elapsed time: {s:.2f} seconds"</span><span class="p">,</span><span class="w"> </span><span class="n">arg</span><span class="p">(</span><span class="s">"s"</span><span class="p">,</span><span class="w"> </span><span class="mf">1.23</span><span class="p">));</span>
</pre></div>
</div>
</p>
</p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N3fmtli2_aEPKcNSt6size_tE">
<span id="_CPPv3N3fmtli2_aEPKcNSt6size_tE"></span><span id="_CPPv2N3fmtli2_aEPKcNSt6size_tE"></span><span class="target" id="format_8h_1ace7b5fd869a5f3a3f1a641dc09931831"></span>internal::UdlArg<char> <code class="sig-prename descclassname">fmt<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">operator""_a</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>s</em>, std::size_t<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmtli2_aEPKcNSt6size_tE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><p><p>C++11 literal equivalent of <a class="reference internal" href="#_CPPv4I0EN3fmt3argEN8internal16NamedArgWithTypeIc1TEE9StringRefRK1T" title="fmt::arg"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">fmt::arg()</span></code></a>.</p>