std::format_to

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

文字處理庫

本地化庫

正則表示式庫 (C++11)

格式化庫 (C++20)

空終止序列工具

位元組字串

多位元組字串

寬字串

原生數值轉換

to_chars (C++17) to_chars_result (C++17) from_chars (C++17) from_chars_result (C++17) chars_format (C++17)

文字編碼標識

text_encoding (C++26)

 

格式化庫

標準格式規範

格式化函式

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

格式字串

basic_format_stringformat_stringwformat_string (C++20起)(C++20起)(C++20起)

runtime_format (C++26)

格式化概念

formattable (C++23)

Formatter

formatter (C++20)

formatter<pair-or-tuple> (C++23)

formatter<range> (C++23)

range_formatter (C++23)

enable_nonlocking_formatter_optimization (C++23)

basic_format_parse_contextformat_parse_contextwformat_parse_context (C++20起)(C++20起)(C++20起)

basic_format_contextformat_contextwformat_context (C++20起)(C++20起)(C++20起)

range_format (C++23)

format_kind (C++23)

格式化引數

basic_format_arg (C++20)

basic_format_arg::handle (C++20)

basic_format_argsformat_argswformat_args (C++20起)(C++20起)(C++20起)

visit_format_arg (C++20) (在 C++26 中廢棄)

make_format_argsmake_wformat_args (C++20起)(C++20起)

格式錯誤

format_error (C++20)

 

定義於標頭檔案 <format>
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out,                     std::format_string<Args...> fmt, Args&&... args );	(1)	(C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out,                     std::wformat_string<Args...> fmt, Args&&... args );	(2)	(C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc,                     std::format_string<Args...> fmt, Args&&... args );	(3)	(C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc,                     std::wformat_string<Args...> fmt, Args&&... args );	(4)	(C++20 起)

根據格式字串 fmt 格式化 args，並將結果寫入輸出迭代器 out。如果存在，loc 用於本地化特定格式。

等價於

1) return std::vformat_to(std::move(out), fmt.str, std::make_format_args(args...));

2) return std::vformat_to(std::move(out), fmt.str, std::make_wformat_args(args...));

3) return std::vformat_to(std::move(out), loc, fmt.str, std::make_format_args(args...));

4) return std::vformat_to(std::move(out), loc, fmt.str, std::make_wformat_args(args...));。

對於過載 (1,3)，令 CharT 為 char；對於過載 (2,4)，令 CharT 為 wchar_t。

這些過載僅當 OutputIt 滿足概念 std::output_iterator<const CharT&> 時才參與過載決議。

如果滿足以下任何條件，則行為是未定義的：

• OutputIt 不符合 std::output_iterator<const CharT&> 模型。
• 對於 Args 中的某些 Ti，std::formatter<Ti, CharT> 不滿足 BasicFormatter 要求（如 std::make_format_args 和 std::make_wformat_args 所要求）。

引數

out	-	指向輸出緩衝區的迭代器
fmt	-	表示格式化字串的物件。格式化字串由以下部分組成： 普通字元（除了 { 和 }），它們原樣複製到輸出， 轉義序列 {{ 和 }}，它們在輸出中分別被 { 和 } 替換，以及 替換欄位。 每個替換欄位具有以下格式： { arg-id (可選) } (1) { arg-id (可選) : format-spec } (2) 1) 沒有格式化規範的替換欄位 2) 帶有格式化規範的替換欄位 arg-id - 指定 args 中用於格式化的引數的索引；如果省略，則按順序使用引數。 格式化字串中的 arg-id 必須全部存在或全部省略。混合手動和自動索引是錯誤的。 format-spec - 由對應引數的 std::formatter 特化定義的格式規範。不能以 } 開頭。 對於基本型別和標準字串型別，格式化規範被解釋為標準格式化規範。 對於 chrono 型別，格式化規範被解釋為chrono 格式化規範。 對於範圍型別，格式化規範被解釋為範圍格式化規範。 對於 std::pair 和 std::tuple，格式規範被解釋為元組格式規範。 對於 std::thread::id 和 std::stacktrace_entry，請參閱執行緒 ID 格式規範和堆疊跟蹤條目格式規範。 對於 std::basic_stacktrace，不允許使用格式化說明符。 (C++23 起) 對於 std::filesystem::path，請參閱路徑格式化規範。 (C++26 起) 對於其他可格式化型別，格式化規範由使用者定義的 formatter 特化決定。
args...	-	要格式化的引數
loc	-	用於特定於語言環境的格式化的 std::locale

返回值

輸出範圍末尾之後的迭代器。

異常

傳播由格式化器或迭代器操作丟擲的任何異常。

注意

根據 P2216R3，如果格式字串不是常量表達式，則會出錯。std::vformat_to 或 std::runtime_format(C++26起) 可用於此情況。

示例

執行此程式碼

#include <format>
#include <iostream>
#include <iterator>
#include <string>
 
int main()
{
    std::string buffer;
 
    std::format_to
    (
        std::back_inserter(buffer), // < OutputIt
        "Hello, C++{}!\n",          // < fmt
        "20"                        // < arg
    );
    std::cout << buffer;
    buffer.clear();
 
    std::format_to
    (
        std::back_inserter(buffer), // < OutputIt
        "Hello, {0}::{1}!{2}",      // < fmt
        "std",                      // < arg {0}
        "format_to()",              // < arg {1}
        "\n",                       // < arg {2}
        "extra param(s)..."         // < unused
    );
    std::cout << buffer << std::flush;
 
    std::wstring wbuffer;
    std::format_to
    (
        std::back_inserter(wbuffer),// < OutputIt
        L"Hello, {2}::{1}!{0}",     // < fmt
        L"\n",                      // < arg {0}
        L"format_to()",             // < arg {1}
        L"std",                     // < arg {2}
        L"...is not..."             // < unused
        L"...an error!"             // < unused
    );
    std::wcout << wbuffer;
}

輸出

Hello, C++20!
Hello, std::format_to()!
Hello, std::format_to()!

缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 3539	C++20	out 不能是僅移動迭代器	它可以是
P2216R3	C++20	對無效格式字串丟擲 std::format_error	導致編譯時錯誤
P2418R2	C++20	既不可 const 使用也不可複製的物件 (例如生成器類物件) 不可格式化	允許格式化這些物件
P2508R1	C++20	該功能沒有使用者可見的名稱	公開了名稱 basic_format_string

另請參閱

format (C++20)	將引數的格式化表示儲存在新字串中 (函式模板)
format_to_n (C++20)	透過輸出迭代器寫出其引數的格式化表示，不超過指定大小 (函式模板)