std::basic_format_arg

 

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 Context > class basic_format_arg;		(C++20 起)

提供對格式化引數的訪問。

basic_format_arg 物件通常由 std::make_format_args 建立，並透過 std::visit_format_arg 或 visit 成員函式(C++26 起) 訪問。

basic_format_arg 物件的行為如同它儲存了以下型別的 std::variant

• std::monostate (僅當物件是預設構造時)
• bool
• Context::char_type
• int
• unsigned int
• long long int
• unsigned long long int
• float
• double
• long double
• const Context::char_type*
• std::basic_string_view<Context::char_type>
• const void*
• basic_format_arg::handle

成員類

handle (C++20)

型別擦除的包裝器，允許格式化使用者定義型別的物件 (公有成員類)

成員函式

(建構函式) (C++20)	構造一個 std::basic_format_arg (公開成員函式)
operator bool (C++20)	檢查當前物件是否持有格式化引數 (公開成員函式)
visit (C++26)	訪問儲存的格式化引數 (公開成員函式)

非成員函式

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

使用者定義格式化器的引數訪問介面 (函式模板)

std::basic_format_arg::basic_format_arg

basic_format_arg() noexcept;		(C++20 起)

預設建構函式。構造一個不持有格式化引數的 basic_format_arg。儲存的物件型別為 std::monostate。

要建立一個持有格式化引數的 basic_format_arg，必須使用 std::make_format_args。

std::basic_format_arg::operator bool

explicit operator bool() const noexcept;		(C++20 起)

檢查 *this 是否持有格式化引數。

如果 *this 持有格式化引數（即儲存的物件型別不是 std::monostate），則返回 true，否則返回 false。

std::basic_format_arg::visit

template< class Visitor > decltype(auto) visit( this basic_format_arg arg, Visitor&& vis );	(1)	(C++26 起)
template< class R, class Visitor > R visit( this basic_format_arg arg, Visitor&& vis );	(2)	(C++26 起)

將訪問器 vis 應用於 arg 中包含的物件。

visit 函式不會修改它所呼叫的 basic_format_arg 物件，因為在呼叫 vis 時會使用物件的副本。

1) 等價於 return std::visit(std::forward<Visitor>(vis), v);，其中 v 是儲存在 arg 中的 std::variant。

2) 等價於 return std::visit<R>(std::forward<Visitor>(vis), v);，其中 v 是儲存在 arg 中的 std::variant。

註解

特性測試宏	值	標準	特性
__cpp_lib_format	202306L	(C++26)	成員 visit

參閱

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

提供對所有格式化引數訪問的類 (類模板)