std:: format
|
Definiert im Header
<format>
|
||
|
template
<
class
...
Args
>
std:: string format ( std:: format_string < Args... > fmt, Args && ... args ) ; |
(1) | (seit C++20) |
|
template
<
class
...
Args
>
std:: wstring format ( std:: wformat_string < Args... > fmt, Args && ... args ) ; |
(2) | (seit C++20) |
|
template
<
class
...
Args
>
std::
string
format
(
const
std::
locale
&
loc,
|
(3) | (seit C++20) |
|
template
<
class
...
Args
>
std::
wstring
format
(
const
std::
locale
&
loc,
|
(4) | (seit C++20) |
Formatiere args gemäß der Formatzeichenkette fmt und gib das Ergebnis als String zurück. Falls vorhanden, wird loc für lokalisierungsabhängige Formatierung verwendet.
Der Format-String
fmt
wird zur Compile-Zeit überprüft
es sei denn, er wird aus dem Ergebnis von
std::runtime_format
initialisiert
(seit C++26)
. Wenn zur Compile-Zeit festgestellt wird, dass der Format-String für die Typen der zu formatierenden Argumente ungültig ist, wird ein Compiler-Fehler ausgegeben.
Die folgenden Anforderungen gelten für jeden Typ
T
in
Args
, wobei
CharT
für Überladungen
(1,3)
char
und für Überladungen
(2,4)
wchar_t
ist:
- std:: formatter < T, CharT > muss BasicFormatter erfüllen
- std:: formatter < T, CharT > :: parse ( ) muss für die Überprüfung von Format-Strings zur Compile-Zeit constexpr sein
Inhaltsverzeichnis |
Parameter
| fmt | - |
Jedes Ersetzungsfeld hat folgendes Format:
1)
Ersetzungsfeld ohne Formatangabe
2)
Ersetzungsfeld mit Formatangabe
|
||||||||||||||||||||||||||||||||||||||||||||||
| args... | - | zu formatierende Argumente | ||||||||||||||||||||||||||||||||||||||||||||||
| loc | - | std::locale verwendet für lokalisierungsspezifische Formatierung | ||||||||||||||||||||||||||||||||||||||||||||||
Rückgabewert
Ein String-Objekt, das das formatierte Ergebnis enthält.
Exceptions
Wirft std::bad_alloc bei Allokierungsfehlern. Propagiert außerdem Ausnahmen, die von beliebigen Formatierern geworfen werden.
Hinweise
Es ist kein Fehler, mehr Argumente bereitzustellen, als das Formatstring erfordert:
std::format("{} {}!", "Hello", "world", "something"); // OK, erzeugt "Hello world!"
Es ist ein Fehler, wenn die Formatzeichenkette kein konstanter Ausdruck ist
es sei denn, sie wird aus dem Ergebnis von
std::runtime_format
(seit C++26)
initialisiert.
std::vformat
hat diese Anforderung nicht.
std::string f1(std::string_view runtime_format_string) { // return std::format(runtime_format_string, "x", 42); // Fehler char v1[] = "x"; int v2 = 42; return std::vformat(runtime_format_string, std::make_format_args(v1, v2)); // OK } std::string f2(std::string_view runtime_format_string) { return std::format(std::runtime_format(runtime_format_string), "x", 42); // OK (C++26) }
Beispiel
#include <format> #include <iostream> #include <set> #include <string> #include <string_view> template<typename... Args> std::string dyna_print(std::string_view rt_fmt_str, Args&&... args) { return std::vformat(rt_fmt_str, std::make_format_args(args...)); } int main() { #ifdef __cpp_lib_format_ranges const std::set<std::string_view> continents { "Africa", "America", "Antarctica", "Asia", "Australia", "Europe" }; std::cout << std::format("Hello {}!\n", continents); #else std::cout << std::format("Hello {}!\n", "continents"); #endif std::string fmt; for (int i{}; i != 3; ++i) { fmt += "{} "; // konstruiert den Formatierungsstring std::cout << fmt << " : "; std::cout << dyna_print(fmt, "alpha", 'Z', 3.14, "unused"); std::cout << '\n'; } }
Mögliche Ausgabe:
Hello {"Africa", "America", "Antarctica", "Asia", "Australia", "Europe"}!
{} : alpha
{} {} : alpha Z
{} {} {} : alpha Z 3.14
Fehlerberichte
Die folgenden verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.
| DR | Angewendet auf | Verhalten wie veröffentlicht | Korrektes Verhalten |
|---|---|---|---|
| P2216R3 | C++20 | wirft std::format_error für ungültige Formatzeichenfolge | ungültige Formatzeichenfolge führt zu Compilezeit-Fehler |
| P2418R2 | C++20 |
Objekte, die weder const-verwendbar noch kopierbar sind
(wie Generator-ähnliche Objekte) sind nicht formatierbar |
Formatierung dieser Objekte erlauben |
| P2508R1 | C++20 | es gibt keinen für Benutzer sichtbaren Namen für diese Einrichtung |
der Name
basic_format_string
wird verfügbar gemacht
|
Siehe auch
|
(C++20)
|
Schreibt eine formatierte Darstellung seiner Argumente über einen Ausgabeiterator
(Funktionsschablone) |
|
(C++20)
|
Schreibt eine formatierte Darstellung seiner Argumente über einen Ausgabeiterator, ohne eine bestimmte Größe zu überschreiten
(Funktionsschablone) |