std::formatted_size

 

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... Args > std::size_t formatted_size( std::format_string<Args...> fmt, Args&&... args );	(1)	(seit C++20)
template< class... Args > std::size_t formatted_size( std::wformat_string<Args...> fmt, Args&&... args );	(2)	(seit C++20)
template< class... Args > std::size_t formatted_size( const std::locale& loc,                             std::format_string<Args...> fmt, Args&&... args );	(3)	(seit C++20)
template< class... Args > std::size_t formatted_size( const std::locale& loc,                             std::wformat_string<Args...> fmt, Args&&... args );	(4)	(seit C++20)

Ermittelt die Gesamtzahl der Zeichen im formatierten String, indem args gemäß dem Formatstring fmt formatiert werden. Falls vorhanden, wird loc für sprachspezifische Formatierung verwendet.

Das Verhalten ist undefiniert, wenn std::formatter<std::remove_cvref_t<Ti>, CharT> die BasicFormatter-Anforderungen für irgendein Ti in Args nicht erfüllt.

Parameter

fmt	-	ein Objekt, das den Formatstring repräsentiert. Der Formatstring besteht aus regulären Zeichen (außer { und }), die unverändert in die Ausgabe kopiert werden, Escape-Sequenzen {{ und }}, die in der Ausgabe durch { und } ersetzt werden, und Ersetzungsfeldern. Jedes Ersetzungsfeld hat das folgende Format: { arg-id (optional) } (1) { arg-id (optional) : format-spec } (2) 1) Ersetzungsfeld ohne Formatangabe 2) Ersetzungsfeld mit Formatangabe arg-id - gibt den Index des Arguments in `args` an, dessen Wert zur Formatierung verwendet werden soll; wenn er weggelassen wird, werden die Argumente in der Reihenfolge verwendet. Die `arg-id`s in einem Formatstring müssen entweder alle vorhanden sein oder alle weggelassen werden. Das Mischen von manueller und automatischer Indizierung ist ein Fehler. format-spec - die Formatangabe, die durch die std::formatter-Spezialisierung für das entsprechende Argument definiert ist. Kann nicht mit } beginnen. Für Basistypen und Standard-Stringtypen wird die Formatangabe als Standard-Formatangabe interpretiert. Für Chrono-Typen wird die Formatangabe als Chrono-Formatangabe interpretiert. Für Bereichstypen wird die Formatangabe als Bereichsformatangabe interpretiert. Für std::pair und std::tuple wird die Formatangabe als Tupel-Formatangabe interpretiert. Für std::thread::id und std::stacktrace_entry siehe Thread-ID-Formatangabe und Stacktrace-Eintrags-Formatangabe. Für std::basic_stacktrace ist keine Formatierungsangabe erlaubt. (seit C++23) Für std::filesystem::path siehe Pfad-Formatangabe. (seit C++26) Für andere formatierbare Typen wird die Formatangabe durch benutzerspezifische formatter-Spezialisierungen bestimmt.
args...	-	zu formatierende Argumente
loc	-	std::locale, die für die lokale-spezifische Formatierung verwendet wird.

Rückgabewert

Die Gesamtzahl der Zeichen im formatierten String.

Ausnahmen

Gibt jede Ausnahme weiter, die vom Formatter ausgelöst wird.

Beispiel

Führen Sie diesen Code aus

#include <format>
#include <iomanip>
#include <iostream>
#include <string_view>
#include <vector>
 
int main()
{
    using namespace std::literals::string_view_literals;
 
    constexpr auto fmt_str{"Hubble's H{0} {1} {2:*^4} miles/sec/mpc."sv};
    constexpr auto sub_zero{"\N{SUBSCRIPT ZERO}"sv}; // "₀" or {0342, 130, 128}
    constexpr auto aprox_equ{"\N{APPROXIMATELY EQUAL TO}"sv}; // "≅" or {0342, 137, 133}
    constexpr int Ho{42}; // H₀
 
    const auto min_buffer_size{std::formatted_size(fmt_str, sub_zero, aprox_equ, Ho)};
    std::cout << "Min buffer size = " << min_buffer_size << '\n';
 
    // Use std::vector as dynamic buffer. The buffer does not include the trailing '\0'.
    std::vector<char> buffer(min_buffer_size);
 
    std::format_to_n(buffer.data(), buffer.size(), fmt_str, sub_zero, aprox_equ, Ho);
    std::cout << "Buffer: "
              << std::quoted(std::string_view{buffer.data(), min_buffer_size})
              << '\n';
 
    // Print the buffer directly after adding the trailing '\0'.
    buffer.push_back('\0');
    std::cout << "Buffer: " << std::quoted(buffer.data()) << '\n';
}

Ausgabe

Min buffer size = 37
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."

Fehlerberichte

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR	angewendet auf	Verhalten wie veröffentlicht	Korrigiertes Verhalten
P2216R3	C++20	wirft std::format_error für ungültige Formatzeichenkette.	ungültige Formatzeichenkette führt zu einem Kompilierungsfehler.
P2418R2	C++20	Objekte, die weder const-benutzbar noch kopierbar sind. (wie Generator-ähnliche Objekte) sind nicht formatierbar	Ermöglichen der Formatierung dieser Objekte
P2508R1	C++20	Es gibt keinen benutzerseitig sichtbaren Namen für diese Einrichtung	Der Name basic_format_string wird verfügbar gemacht

Siehe auch

format_to (C++20)	schreibt die formatierte Darstellung ihrer Argumente über einen Output-Iterator (Funktionstemplate)
format_to_n (C++20)	schreibt die formatierte Darstellung ihrer Argumente über einen Output-Iterator, überschreitet nicht die angegebene Größe (Funktionstemplate)