CKTIS / C++
std::formatter : contrat de formatage d’un type
Une spécialisation std::formatter<T, charT> définit l’analyse de la spécification et l’écriture d’une valeur T.
Version : C++23
Syntaxe
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> de <format> est le point de personnalisation utilisé par std::format et les fonctions associées pour un argument. Un formatter satisfait BasicFormatter/Formatter : parse(ctx) analyse la partie après les deux-points et renvoie le premier caractère non consommé, normalement }, tandis que format(value, ctx) écrit via ctx.out() et renvoie l’itérateur après sa sortie.
L’exemple spécialise std::formatter<Point> pour un type du programme. parse renvoie ctx.begin(), donc seule une spécification vide est acceptée ; format délègue les coordonnées à std::format_to. Le résultat est p=(3, 4). La spécialisation doit être visible lors de la vérification du littéral. Les options lues par parse peuvent être stockées dans le formatter puis utilisées par format.
Une partie non analysée autre que l’arrêt sur } exige std::format_error. La signature de format doit gérer la qualification requise de la valeur et un formatter const afin que les valeurs const soient formatables selon C++23 ; l’itérateur renvoyé doit être la vraie fin de sortie. Une spécialisation est permise pour un type défini par le programme, pas le remplacement arbitraire des spécialisations de types standard. Contexte et itérateurs ne survivent pas à l’appel.
Exemples
#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';
}
Résultat
p=(3, 4)
std::formatter → p=(3, 4)