std::basic_format_string, std::format_string, std::wformat_string

 

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 CharT, class... Args > struct basic_format_string;	(1)	(C++20 起)
template< class... Args > using format_string =     basic_format_string<char, std::type_identity_t<Args>...>;	(2)	(C++20 起)
template< class... Args > using wformat_string =     basic_format_string<wchar_t, std::type_identity_t<Args>...>;	(3)	(C++20 起)

類模板 std::basic_format_string 封裝一個 std::basic_string_view，該物件將由格式化函式使用。

std::basic_format_string 的建構函式在編譯時執行格式字串檢查，除非建構函式引數由 std::runtime_format 返回(C++26 起)。

成員函式

(建構函式)	構造一個 basic_format_string，如果引數不是格式字串，則引發編譯錯誤 (公開成員函式)
get	返回封裝的字串 (公開成員函式)

std::basic_format_string::basic_format_string

template< class T > consteval basic_format_string( const T& s );	(1)
basic_format_string( /* runtime-format-string */<CharT> s ) noexcept;	(2)	(C++26 起)

1) 構造一個 basic_format_string 物件，它儲存字串 s 的檢視。如果引數不是編譯時常量，或者它不能被解析為格式化引數型別 Args 的格式字串，則構造是病態的。

此過載僅當 const T& 滿足 std::convertible_to<std::basic_string_view<CharT>> 模型時才參與過載決議。

2) 構造一個 basic_format_string 物件，它儲存由 std::runtime_format 返回的字串 s 的檢視。它在構造時不執行格式字串檢查。

引數

s

-

表示格式化字串的物件。格式化字串由以下部分組成： 普通字元（除了 { 和 }），它們被原樣複製到輸出， 轉義序列 {{ 和 }}，它們在輸出中分別被替換為 { 和 }，以及 替換欄位。 每個替換欄位具有以下格式： { 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 特化決定。

std::basic_format_string::get

constexpr std::basic_string_view<CharT> get() const noexcept;

返回儲存的字串檢視。

註記

別名模板 format_string 和 wformat_string 使用 std::type_identity_t 來禁止模板引數推導。通常，當它們作為函式引數出現時，它們的模板引數是從其他函式引數推匯出來的。

template<class... Args>
std::string format(std::format_string<Args...> fmt, Args&&... args);
 
auto s = format("{} {}", 1.0, 2);
// Calls format<double, int>. Args are deduced from 1.0, 2
// Due to the use of type_identity_t in format_string, template argument deduction
// does not consider the type of the format string.

缺陷報告

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

缺陷報告	應用於	釋出時的行為	正確的行為
P2508R1	C++20	該功能沒有使用者可見的名稱	公開了名稱 basic_format_string