上传cppreference
This commit is contained in:
207
web/cppreference-zh/chmhelp/cpp-utility-format-format.html
Normal file
207
web/cppreference-zh/chmhelp/cpp-utility-format-format.html
Normal file
@@ -0,0 +1,207 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="zh" dir="ltr" class="client-nojs" xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh">
|
||||
<head><meta http-equiv="x-ua-compatible" content="ie=edge">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>std::format</title>
|
||||
<link rel="stylesheet" href="ext.css" />
|
||||
<link rel="stylesheet" href="site_modules.css" />
|
||||
</head>
|
||||
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-cpp_utility_format_format skin-cppreference2 action-view cpp-navbar">
|
||||
<div id="cpp-content-base">
|
||||
<div id="content"><a id="top"></a>
|
||||
<h1 id="firstHeading" class="firstHeading"><span style="font-size:0.7em; line-height:130%">std::</span>format</h1>
|
||||
<div id="bodyContent">
|
||||
<div id="contentSub"><span class="subpages">< <a href="cpp.html">cpp</a>‎ | <a href="cpp-utility.html">utility</a>‎ | <a href="cpp-utility-format.html">format</a></span></div>
|
||||
<div id="mw-content-text" lang="zh" dir="ltr" class="mw-content-ltr" xml:lang="zh">
|
||||
<table class="t-dcl-begin">
|
||||
<tbody>
|
||||
<tr class="t-dsc-header">
|
||||
<td>
|
||||
<div>定义于头文件 <code><a href="cpp-header-format.html"><format></a></code></div>
|
||||
</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="t-dcl t-since-cxx20">
|
||||
<td>
|
||||
<div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span> <span class="kw1">class</span>... <span class="me1">Args</span> <span class="sy1">></span><br />
|
||||
<a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> format<span class="br0">(</span> <span class="coMULTI">/*format_string<Args...>*/</span> fmt, <span class="kw4">const</span> Args<span class="sy3">&</span>... <span class="me1">args</span> <span class="br0">)</span><span class="sy4">;</span></span></div>
|
||||
</td>
|
||||
<td>(1)</td>
|
||||
<td><span class="t-mark-rev t-since-cxx20">(C++20 起)</span></td>
|
||||
</tr>
|
||||
<tr class="t-dcl t-since-cxx20">
|
||||
<td>
|
||||
<div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span> <span class="kw1">class</span>... <span class="me1">Args</span> <span class="sy1">></span><br />
|
||||
<a href="cpp-string-basic_string.html"><span class="kw1232">std::<span class="me2">wstring</span></span></a> format<span class="br0">(</span> <span class="coMULTI">/*wformat_string<Args...>*/</span> fmt, <span class="kw4">const</span> Args<span class="sy3">&</span>... <span class="me1">args</span> <span class="br0">)</span><span class="sy4">;</span></span></div>
|
||||
</td>
|
||||
<td>(2)</td>
|
||||
<td><span class="t-mark-rev t-since-cxx20">(C++20 起)</span></td>
|
||||
</tr>
|
||||
<tr class="t-dcl t-since-cxx20">
|
||||
<td>
|
||||
<div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span> <span class="kw1">class</span>... <span class="me1">Args</span> <span class="sy1">></span><br /></span>
|
||||
<p><a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> format<span class="br0">(</span> <span class="kw4">const</span> <a href="cpp-locale-locale.html"><span class="kw1894">std::<span class="me2">locale</span></span></a><span class="sy3">&</span> loc,<br /></p>
|
||||
<span class="coMULTI">/*format_string<Args...>*/</span> fmt, <span class="kw4">const</span> Args<span class="sy3">&</span>... <span class="me1">args</span> <span class="br0">)</span><span class="sy4">;</span></div>
|
||||
</td>
|
||||
<td>(3)</td>
|
||||
<td><span class="t-mark-rev t-since-cxx20">(C++20 起)</span></td>
|
||||
</tr>
|
||||
<tr class="t-dcl t-since-cxx20">
|
||||
<td>
|
||||
<div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span> <span class="kw1">class</span>... <span class="me1">Args</span> <span class="sy1">></span><br /></span>
|
||||
<p><a href="cpp-string-basic_string.html"><span class="kw1232">std::<span class="me2">wstring</span></span></a> format<span class="br0">(</span> <span class="kw4">const</span> <a href="cpp-locale-locale.html"><span class="kw1894">std::<span class="me2">locale</span></span></a><span class="sy3">&</span> loc,<br /></p>
|
||||
<span class="coMULTI">/*wformat_string<Args...>*/</span> fmt, <span class="kw4">const</span> Args<span class="sy3">&</span>... <span class="me1">args</span> <span class="br0">)</span><span class="sy4">;</span></div>
|
||||
</td>
|
||||
<td>(4)</td>
|
||||
<td><span class="t-mark-rev t-since-cxx20">(C++20 起)</span></td>
|
||||
</tr>
|
||||
<tr class="t-dcl-sep">
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>按照格式字符串 <code>fmt</code> 格式化 <code>args</code> ,并返回作为 string 的结果。 <code>loc</code> 若存在,则用于本地环境特定的格式化。</p>
|
||||
<p>若对 <code>Args</code> 中的任一 <code>Ti</code> , <span class="t-c"><span class="mw-geshi cpp source-cpp">std<span class="sy4">::</span><span class="me2">formatter</span><span class="sy1"><</span>Ti, CharT<span class="sy1">></span></span></span> 不满足<a href="cpp-named_req-Formatter.html"><span style="font-style:italic">格式化器</span> <span style="font-family: Georgia, 'DejaVu Serif', serif; font-style:italic">(Formatter)</span></a> 要求则行为未定义,其中 <code>CharT</code> 是对重载 <span class="t-v">(1,3)</span> 为 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw4">char</span></span></span> ,对重载 <span class="t-v">(2,4)</span> 为 <code>wchar_t</code> 。</p>
|
||||
<h3><span class="mw-headline" id=".E5.8F.82.E6.95.B0">参数</span></h3>
|
||||
<table class="t-par-begin">
|
||||
<tr class="t-par">
|
||||
<td>fmt</td>
|
||||
<td>-</td>
|
||||
<td>
|
||||
<div class="t-template-editlink" style=""></div>
|
||||
未指定类型的形参,其初始化仅若实参可转换成 <span class="t-lc"><a href="cpp-string-basic_string_view.html">std::string_view</a></span> (对于 <span class="t-v">(1,3)</span> )或 <span class="t-lc"><a href="cpp-string-basic_string_view.html">std::wstring_view</a></span> (对于 <span class="t-v">(2,4)</span> ),而转换结果是常量表达式和 <code>Args</code> 的合法格式字符串才合法。格式字符串由以下内容组成:
|
||||
<ul>
|
||||
<li>通常字符(除了 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">{</span></span></span> 与 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">}</span></span></span> ),它们被不加修改地复制到输出,</li>
|
||||
<li>转义序列 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">{</span><span class="br0">{</span></span></span> 与 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">}</span><span class="br0">}</span></span></span> ,它们在输出中被分别替换成 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">{</span></span></span> 与 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">}</span></span></span> ,以及</li>
|
||||
<li>替换域。</li>
|
||||
</ul>
|
||||
<p>每个替换域拥有下列格式:</p>
|
||||
<ul>
|
||||
<li>引入的 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">{</span></span></span> 字符;</li>
|
||||
<li><span class="t-mark">(可选)</span> <span class="t-spar">arg-id</span> ,一个非负数;</li>
|
||||
<li><span class="t-mark">(可选)</span> 冒号( <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="sy4">:</span></span></span> )后随格式说明;</li>
|
||||
<li>终止的 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="br0">}</span></span></span> 字符。</li>
|
||||
</ul>
|
||||
<p><span class="t-spar">arg-id</span> 指定用于格式化其值的 <code>args</code> 中的参数的下标;若省略 <span class="t-spar">arg-id</span> ,则按顺序使用参数。格式字符串中的 <span class="t-spar">arg-id</span> 必须全部存在或全部被省略。混合手动和自动指定下标是错误。</p>
|
||||
<p>格式说明由对应参数特化的 <span class="t-lc">std::formatter</span> 定义。</p>
|
||||
<ul>
|
||||
<li>对于基本类型和标准字符串类型,格式说明为<a href="cpp-utility-format-formatter.html#.E6.A0.87.E5.87.86.E6.A0.BC.E5.BC.8F.E8.AF.B4.E6.98.8E">标准格式说明</a>;</li>
|
||||
<li>对于标准日期和时间类型,格式说明为 <a href="cpp-chrono-system_clock-formatter.html#.E6.A0.BC.E5.BC.8F.E8.AF.B4.E6.98.8E">chrono 格式说明</a>;</li>
|
||||
<li>对于用户定义类型,格式说明由用户定义的 <span class="t-lc">std::formatter</span> 特化决定。</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="t-par">
|
||||
<td>args...</td>
|
||||
<td>-</td>
|
||||
<td>要格式化的参数</td>
|
||||
</tr>
|
||||
<tr class="t-par">
|
||||
<td>loc</td>
|
||||
<td>-</td>
|
||||
<td>用于本地环境特定格式化的 <span class="t-lc"><a href="cpp-locale-locale.html">std::locale</a></span></td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3><span class="mw-headline" id=".E8.BF.94.E5.9B.9E.E5.80.BC">返回值</span></h3>
|
||||
<p>保有格式化结果的 string 对象。</p>
|
||||
<h3><span class="mw-headline" id=".E5.BC.82.E5.B8.B8">异常</span></h3>
|
||||
<p>在分配失败时抛出 <span class="t-lc"><a href="cpp-memory-new-bad_alloc.html">std::bad_alloc</a></span> 。并且会传播任何格式化器所抛的异常。</p>
|
||||
<h3><span class="mw-headline" id=".E6.B3.A8.E8.A7.A3">注解</span></h3>
|
||||
<p>提供多于格式字符串所要求的参数不是错误:</p>
|
||||
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
||||
<div class="cpp source-cpp">
|
||||
<pre class="de1">std<span class="sy4">::</span><span class="me2">format</span><span class="br0">(</span><span class="st0">"{} {}!"</span>, <span class="st0">"Hello"</span>, <span class="st0">"world"</span>, <span class="st0">"something"</span><span class="br0">)</span><span class="sy4">;</span> <span class="co1">// OK :产生 "Hello world!"</span></pre></div>
|
||||
</div>
|
||||
<p>自 <a rel="nofollow" class="external text" href="https://wg21.link/P2216R3">P2216R3</a> 起,格式字符串不是常量表达式是错误。此情况下可使用 <span class="t-lc">std::vformat</span> 。</p>
|
||||
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
||||
<div class="cpp source-cpp">
|
||||
<pre class="de1"><a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> f<span class="br0">(</span><a href="cpp-string-basic_string_view.html"><span class="kw1248">std::<span class="me2">string_view</span></span></a> runtime_format_string<span class="br0">)</span> <span class="br0">{</span>
|
||||
<span class="co1">// return std::format(runtime_format_string, "foo", "bar"); // 错误</span>
|
||||
<span class="kw1">return</span> std<span class="sy4">::</span><span class="me2">vformat</span><span class="br0">(</span>runtime_format_string, std<span class="sy4">::</span><span class="me2">make_format_args</span><span class="br0">(</span><span class="st0">"foo"</span>, <span class="st0">"bar"</span><span class="br0">)</span><span class="br0">)</span><span class="sy4">;</span> <span class="co1">// OK</span>
|
||||
<span class="br0">}</span></pre></div>
|
||||
</div>
|
||||
<h3><span class="mw-headline" id=".E7.A4.BA.E4.BE.8B">示例</span></h3>
|
||||
<div class="t-example">
|
||||
<div class="t-example-live-link"></div>
|
||||
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
||||
<div class="cpp source-cpp">
|
||||
<pre class="de1"><span class="co2">#include <format></span>
|
||||
<span class="co2">#include <iostream></span>
|
||||
<span class="co2">#include <string></span>
|
||||
<span class="co2">#include <string_view></span>
|
||||
|
||||
<span class="kw1">template</span> <span class="sy1"><</span><span class="kw1">typename</span>... <span class="me1">Args</span><span class="sy1">></span>
|
||||
<a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> dyna_print<span class="br0">(</span><a href="cpp-string-basic_string_view.html"><span class="kw1248">std::<span class="me2">string_view</span></span></a> rt_fmt_str, Args<span class="sy3">&&</span>... <span class="me1">args</span><span class="br0">)</span> <span class="br0">{</span>
|
||||
<span class="kw1">return</span> std<span class="sy4">::</span><span class="me2">vformat</span><span class="br0">(</span>rt_fmt_str, std<span class="sy4">::</span><span class="me2">make_format_args</span><span class="br0">(</span>args...<span class="br0">)</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
<span class="br0">}</span>
|
||||
|
||||
<span class="kw4">int</span> main<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span>
|
||||
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">format</span><span class="br0">(</span><span class="st0">"Hello {}!<span class="es1">\n</span>"</span>, <span class="st0">"world"</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
|
||||
<a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> fmt<span class="sy4">;</span>
|
||||
<span class="kw1">for</span> <span class="br0">(</span><span class="kw4">int</span> i<span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span> i <span class="sy3">!</span><span class="sy1">=</span> <span class="nu0">3</span><span class="sy4">;</span> <span class="sy2">++</span>i<span class="br0">)</span> <span class="br0">{</span>
|
||||
fmt <span class="sy2">+</span><span class="sy1">=</span> <span class="st0">"{} "</span><span class="sy4">;</span> <span class="co1">// 构造格式化字符串</span>
|
||||
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> fmt <span class="sy1"><<</span> <span class="st0">" : "</span><span class="sy4">;</span>
|
||||
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> dyna_print<span class="br0">(</span>fmt, <span class="st0">"alpha"</span>, <span class="st0">'Z'</span>, <span class="nu16">3.14</span>, <span class="st0">"unused"</span><span class="br0">)</span><span class="sy4">;</span>
|
||||
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
|
||||
<span class="br0">}</span>
|
||||
<span class="br0">}</span></pre></div>
|
||||
</div>
|
||||
<p>输出:</p>
|
||||
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
||||
<div class="text source-text">
|
||||
<pre class="de1">Hello world!
|
||||
{} : alpha
|
||||
{} {} : alpha Z
|
||||
{} {} {} : alpha Z 3.14</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<h3><span class="mw-headline" id=".E7.BC.BA.E9.99.B7.E6.8A.A5.E5.91.8A">缺陷报告</span></h3>
|
||||
<p>下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。</p>
|
||||
<table class="dsctable" style="font-size:0.8em">
|
||||
<tr>
|
||||
<th>DR</th>
|
||||
<th>应用于</th>
|
||||
<th>出版时的行为</th>
|
||||
<th>正确行为</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a rel="nofollow" class="external text" href="https://wg21.link/P2216R3">P2216R3</a></td>
|
||||
<td>C++20</td>
|
||||
<td>对非法格式字符串抛出 <span class="t-lc">std::format_error</span></td>
|
||||
<td>非法格式字符串导致编译时错误</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3><span class="mw-headline" id=".E5.8F.82.E9.98.85">参阅</span></h3>
|
||||
<table class="t-dsc-begin">
|
||||
<tr class="t-dsc">
|
||||
<td>
|
||||
<div class="t-dsc-member-div">
|
||||
<div><a href="cpp-utility-format-format_to.html"><span class="t-lines"><span>format_to</span></span></a></div>
|
||||
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
||||
</div>
|
||||
</td>
|
||||
<td>通过输出迭代器写其参数的格式化表示<br />
|
||||
<span class="t-mark">(函数模板)</span></td>
|
||||
</tr>
|
||||
<tr class="t-dsc">
|
||||
<td>
|
||||
<div class="t-dsc-member-div">
|
||||
<div><a href="cpp-utility-format-format_to_n.html"><span class="t-lines"><span>format_to_n</span></span></a></div>
|
||||
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
||||
</div>
|
||||
</td>
|
||||
<td>通过输出迭代器写其参数的格式化表示,不超出指定的大小<br />
|
||||
<span class="t-mark">(函数模板)</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="visualClear"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user