std::basic_format_arg

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

技術仕様書

 

ユーティリティライブラリ

言語サポート 型サポート (基本型、RTTI、型特性) ライブラリの機能テストマクロ (C++20) 動的メモリ管理 プログラムユーティリティ エラー処理 コルーチンサポート (C++20) 可変長引数関数 launder (C++17) initializer_list (C++11) source_location (C++20) 三方比較 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

汎用ユーティリティ 日付と時間 関数オブジェクト 書式化ライブラリ (C++20) bitset hash (C++11) integer_sequence (C++14) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_not_equalcmp_lesscmp_greatercmp_less_thancmp_greater_than (C++20)(C++20)(C++20)(C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) 一般的な語彙の型 pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) 初等文字列変換 to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

書式化ライブラリ

書式化関数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

フォーマッタ

formatter (C++20)

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)

書式化引数

basic_format_arg (C++20)

basic_format_argsformat_argswformat_argsformat_args_t (C++20)(C++20)(C++20)(C++20)

visit_format_arg (C++20)

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

書式化エラー

format_error (C++20)

 

<tbody> </tbody>

ヘッダ <format> で定義
template<class Context> class basic_format_arg;		(C++20以上)

書式化引数へのアクセスを提供します。

basic_format_arg オブジェクトは一般的には std::make_format_args によって作成され std::visit_format_arg を通してアクセスされます。

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	ユーザ定義型オブジェクトの書式化を可能にするための型消去されたラッパー。 (クラス)

メンバ関数

コンストラクタ	std::basic_format_arg を構築します。 (パブリックメンバ関数)
operator bool	書式化引数を保持するかどうか調べます。 (パブリックメンバ関数)

非メンバ関数

visit_format_arg (C++20)

ユーザ定義フォーマッタのための引数 visit インタフェース (関数テンプレート)

std::basic_format_arg::handle

<tbody> </tbody>

template<class Context> class basic_format_arg<Context>::handle;

ユーザ定義型オブジェクトの書式化を可能にします。

メンバ関数

format

指定された文脈で参照先のオブジェクトを書式化します。 (パブリックメンバ関数)

std::basic_format_arg::handle::format

<tbody> </tbody>

void format(std::basic_format_parse_context<Context::char_type>& parse_ctx, Context& format_ctx) const;

T を紐付いた書式化引数の型、 ref を書式化引数を参照する const T& とします。 以下と同等です。

typename Context::template formatter_type<T> f; parse_ctx.advance_to(f.parse(parse_ctx)); format_ctx.advance_to(f.format(ref, format_ctx));

std::basic_format_arg::basic_format_arg

<tbody> </tbody>

basic_format_arg() noexcept;

デフォルトコンストラクタ。 書式化引数を保持しない basic_format_arg を構築します。 格納されるオブジェクトの型は std::monostate です。

書式化引数を保持する basic_format_arg を作成するためには std::make_format_args を使用する必要があります。

std::basic_format_arg::operator bool

<tbody> </tbody>

explicit operator bool() const noexcept;

*this が書式化引数を保持しているかどうか調べます。

*this が書式化引数を保持する (格納されているオブジェクトの型が std::monostate でない) 場合は true、そうでなければ false を返します。