std::basic_format_arg

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Textverarbeitungsbibliothek

Lokalisierungsbibliothek

Reguläre Ausdrücke-Bibliothek (C++11)

Formatierungsbibliothek (C++20)

Dienstprogramme für Null-terminierte Sequenzen

Byte-Zeichenketten

Multibyte-Zeichenketten

Wide-Zeichenketten

Primitive numerische Konvertierungen

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

Textkodierungserkennung

text_encoding (C++26)

 

Formatierungsbibliothek

Standardformat-Spezifikation

Formatierungsfunktionen

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

Format-Strings

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

runtime_format (C++26)

Formatierungs-Konzepte

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)

Formatierungs-Argumente

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) (veraltet in C++26)

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

Format-Fehler

format_error (C++20)

 

Definiert in Header <format>
template< class Context > class basic_format_arg;		(seit C++20)

Bietet Zugriff auf ein Formatierungsargument.

basic_format_arg Objekte werden typischerweise von std::make_format_args erstellt und über std::visit_format_arg oder die visit-Memberfunktionen(seit C++26) zugegriffen.

Ein basic_format_arg Objekt verhält sich so, als ob es ein std::variant der folgenden Typen speichert

• std::monostate (nur wenn das Objekt default-konstruiert wurde)
• 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

Member-Klassen

handle (C++20)

Type-erased Wrapper, der das Formatieren eines Objekts eines benutzerdefinierten Typs ermöglicht (public member class)

Member-Funktionen

(Konstruktor) (C++20)	Konstruiert ein std::basic_format_arg (öffentliche Memberfunktion)
operator bool (C++20)	Prüft, ob das aktuelle Objekt ein Formatierungsargument enthält (öffentliche Memberfunktion)
visit (C++26)	Besucht das gespeicherte Formatierungsargument (öffentliche Memberfunktion)

Nicht-Member-Funktionen

visit_format_arg (C++20) (veraltet in C++26)

Argument-Visitationsschnittstelle für benutzerdefinierte Formatierer (Funktionstemplate)

std::basic_format_arg::basic_format_arg

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

Default-Konstruktor. Erzeugt ein basic_format_arg, das kein Formatierungsargument enthält. Das gespeicherte Objekt hat den Typ std::monostate.

Um ein basic_format_arg zu erstellen, das ein Formatierungsargument enthält, muss std::make_format_args verwendet werden.

std::basic_format_arg::operator bool

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

Prüft, ob *this ein Formatierungsargument enthält.

Gibt true zurück, wenn *this ein Formatierungsargument enthält (d.h. das gespeicherte Objekt hat nicht den Typ std::monostate), andernfalls false.

std::basic_format_arg::visit

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

Wendet den Visitor vis auf das von arg enthaltene Objekt an.

Die visit-Funktionen ändern das basic_format_arg Objekt, auf dem sie aufgerufen werden, nicht, da beim Aufruf von vis eine Kopie des Objekts verwendet wird.

1) Äquivalent zu return std::visit(std::forward<Visitor>(vis), v);, wobei v der in arg gespeicherte std::variant ist.

2) Äquivalent zu return std::visit<R>(std::forward<Visitor>(vis), v);, wobei v der in arg gespeicherte std::variant ist.

Hinweise

Feature-Test-Makro	Wert	Std	Feature
__cpp_lib_format	202306L	(C++26)	Member visit

Siehe auch

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

Klasse, die Zugriff auf alle Formatierungsargumente ermöglicht (Klassentemplate)