Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / C++

std::formatter: contratto di formattazione di un tipo

Una specializzazione std::formatter<T, charT> definisce l’analisi della specifica e la scrittura di un valore T.

Versione: C++23

Sintassi

template<class T, class CharT = char>
struct std::formatter;

// A usable specialization provides conceptually:
constexpr auto parse(std::basic_format_parse_context<CharT>& ctx);
template<class FormatContext>
auto format(const T& value, FormatContext& ctx) const;

std::formatter<T, charT> di <format> è il punto di personalizzazione usato da std::format e funzioni correlate per un argomento. Un formatter soddisfa BasicFormatter/Formatter: parse(ctx) analizza la parte dopo i due punti e restituisce il primo carattere non consumato, normalmente }, mentre format(value, ctx) scrive tramite ctx.out() e restituisce l’iteratore dopo l’output.

L’esempio specializza std::formatter<Point> per un tipo del programma. parse restituisce ctx.begin(), quindi accetta solo una specifica vuota, e format delega le coordinate a std::format_to; il risultato è p=(3, 4). La specializzazione deve essere visibile quando il letterale viene controllato. Le opzioni lette da parse possono essere memorizzate nel formatter e usate in format.

Lasciare una parte non analizzata, oltre all’arresto su }, richiede std::format_error. La firma di format deve gestire la qualificazione richiesta del valore e un formatter const affinché i valori const siano formattabili in C++23; l’iteratore restituito deve essere la vera fine dell’output. Si può specializzare per un tipo definito dal programma, non sostituire arbitrariamente specializzazioni di tipi standard. Contesto e iteratori non sopravvivono alla chiamata.

Esempi

#include <format>
#include <iostream>

struct Point {
    int x;
    int y;
};

template<>
struct std::formatter<Point> {
    constexpr auto parse(std::format_parse_context& ctx) {
        return ctx.begin();
    }

    auto format(const Point& point, std::format_context& ctx) const {
        return std::format_to(ctx.out(), "({}, {})", point.x, point.y);
    }
};

int main() {
    std::cout << std::format("p={}", Point{3, 4}) << '\n';
}

Risultato

p=(3, 4)

std::formatter → p=(3, 4)

Fonti