std::format_to_n, std::format_to_n_result

 

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 > std::format_to_n_result<OutputIt>     format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,                  std::format_string<Args...> fmt, Args&&... args );	(1)	(C++20 起)
template< class OutputIt, class... Args > std::format_to_n_result<OutputIt>     format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,                  std::wformat_string<Args...> fmt, Args&&... args );	(2)	(C++20 起)
template< class OutputIt, class... Args > std::format_to_n_result<OutputIt>     format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,                  const std::locale& loc,                  std::format_string<Args...> fmt, Args&&... args );	(3)	(C++20 起)
template< class OutputIt, class... Args > std::format_to_n_result<OutputIt>     format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,                  const std::locale& loc,                  std::wformat_string<Args...> fmt, Args&&... args );	(4)	(C++20 起)
輔助型別
template< class OutputIt > struct format_to_n_result {     OutputIt out;     std::iter_difference_t<OutputIt> size; };	(5)	(C++20 起)

根據格式字串 fmt 格式化 args，並將結果寫入輸出迭代器 out。最多寫入 n 個字元。如果存在，loc 用於語言環境特定的格式化。

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

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

如果 OutputIt 不滿足 (符合語義要求) 概念 std::output_iterator<const CharT&>，或者對於 Args 中的任何 Ti，std::formatter<std::remove_cvref_t<Ti>, CharT> 不滿足 BasicFormatter 要求，則行為未定義。

5) std::format_to_n_result 沒有基類，也沒有除 out、size 和隱式宣告的特殊成員函式之外的成員。

引數

out	-	指向輸出緩衝區的迭代器
n	-	寫入緩衝區的最大字元數
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

返回值

一個 format_to_n_result，其中 out 成員是輸出範圍末尾之後的迭代器，size 成員是總的（未截斷的）輸出大小。

異常

傳播 formatter 或迭代器操作丟擲的任何異常。

注意

在 GCC-13.3 之前的 libstdc++ 實現中，報告正確的 format_to_n_result::out 值時存在 一個錯誤。

示例

在 Godbolt 的編譯器瀏覽器上： clang (trunk) + libc++， GCC (trunk) + libstdc++。

執行此程式碼

#include <format>
#include <initializer_list>
#include <iomanip>
#include <iostream>
#include <string_view>
 
int main()
{
    char buffer[64];
 
    for (std::size_t max_chars_to_write : {std::size(buffer) - 1, 23uz, 21uz})
    {
        const std::format_to_n_result result =
            std::format_to_n(
                buffer, max_chars_to_write,
                "Hubble's H{2} {3} {0}{4}{1} km/sec/Mpc.", // 24 bytes w/o formatters
                71,       // {0}, occupies 2 bytes
                8,        // {1}, occupies 1 byte
                "\u2080", // {2}, occupies 3 bytes, '₀' (SUBSCRIPT ZERO)
                "\u2245", // {3}, occupies 3 bytes, '≅' (APPROXIMATELY EQUAL TO)
                "\u00B1"  // {4}, occupies 2 bytes, '±' (PLUS-MINUS SIGN)
                ); // 24 + 2 + 1 + 3 + 3 + 2 == 35, no trailing '\0'
 
        *result.out = '\0'; // adds terminator to buffer
 
        const std::string_view str(buffer, result.out);
 
        std::cout << "Buffer until '\\0': " << std::quoted(str) << '\n'
                  << "Max chars to write: " << max_chars_to_write << '\n'
                  << "result.out offset: " << result.out - buffer << '\n'
                  << "Untruncated output size: " << result.size << "\n\n";
    }
}

輸出

Buffer until '\0': "Hubble's H₀ ≅ 71±8 km/sec/Mpc."
Max chars to write: 63
result.out offset: 35
Untruncated output size: 35
 
Buffer until '\0': "Hubble's H₀ ≅ 71±8"
Max chars to write: 23
result.out offset: 23
Untruncated output size: 35
 
Buffer until '\0': "Hubble's H₀ ≅ 71�"
Max chars to write: 21
result.out offset: 21
Untruncated output size: 35

缺陷報告

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

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

參閱

format (C++20)	將引數的格式化表示儲存在新字串中 (函式模板)
format_to (C++20)	透過輸出迭代器寫出其引數的格式化表示 (函式模板)
formatted_size (C++20)	確定儲存其引數格式化表示所需的字元數 (函式模板)