WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C++

std::format_to: Formatierung über einen Ausgabeiterator

std::format_to schreibt formatierte Zeichen über einen Ausgabeiterator und liefert den Iterator hinter dem letzten Schreibvorgang.

Version: C++23

Syntax

template<class Out, class... Args>
Out std::format_to(Out out, std::format_string<Args...> fmt, Args&&... args);

template<class Out, class... Args>
Out std::format_to(Out out, std::wformat_string<Args...> fmt, Args&&... args);

template<class Out, class... Args>
Out std::format_to(Out out, const std::locale& loc,
    std::format_string<Args...> fmt, Args&&... args);

template<class Out, class... Args>
Out std::format_to(Out out, const std::locale& loc,
    std::wformat_string<Args...> fmt, Args&&... args);

std::format_to(out, fmt, args...) aus <format> formatiert wie std::format, erzeugt aber keinen Ergebnisstring: Die Zeichen werden nacheinander über out zugewiesen. Der Rückgabewert zeigt unmittelbar hinter das zuletzt geschriebene Zeichen. Es gibt Formen für char und wchar_t sowie Overloads mit std::locale.

Das Beispiel schreibt "2 + 3 = 5" an den Anfang eines Zeichenarrays und berechnet aus dem zurückgegebenen Iterator 9 geschriebene Zeichen; die Ausgabe ist 2 + 3 = 5|9. Es wird kein Nullzeichen angehängt, daher erhält der View eine explizite Länge. Für einen wachsenden Container ist std::back_inserter das übliche Ziel.

Der Zieliterator muss den passenden Zeichentyp annehmen und für das gesamte Ergebnis beschreibbar bleiben. In einem zu kleinen Puffer erfüllt ein gewöhnlicher Iterator die Ausgabeiterator-Anforderungen nicht mehr; weiteres Schreiben hat undefiniertes Verhalten, denn format_to kennt die Kapazität nicht. Ein literales format_string wird gegen die Argumente geprüft. Formatfehler können std::format_error, Allokationen std::bad_alloc auslösen; Ausnahmen von Formatter oder Iterator werden weitergereicht. Für eine Schreibgrenze dient std::format_to_n.

Beispiele

#include <array>
#include <format>
#include <iostream>
#include <string_view>

int main() {
    std::array<char, 32> buffer{};
    const auto end = std::format_to(buffer.begin(), "{} + {} = {}", 2, 3, 5);
    const std::string_view result(buffer.data(), end - buffer.begin());
    std::cout << result << '|' << result.size() << '\n';
}

Ergebnis

2 + 3 = 5|9

std::format_to → 2 + 3 = 5|9

Quellen