База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / C++

std::formatter: договор за форматиране на тип

Специализация std::formatter<T, charT> определя разчитането на спецификацията и записването на стойност T.

Версия: C++23

Синтаксис

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> от <format> е точката за персонализиране, която std::format и сродните функции използват за един аргумент. Formatter изпълнява BasicFormatter/Formatter: parse(ctx) анализира частта след двоеточието и връща първия неизползван знак, обикновено }, а format(value, ctx) пише чрез ctx.out() и връща итератора след изхода.

Примерът специализира std::formatter<Point> за програмен тип. parse връща ctx.begin(), затова приема само празна спецификация, а format делегира координатите на std::format_to; резултатът е p=(3, 4). Специализацията трябва да се вижда при проверката на литерала. Опции от parse могат да се пазят във formatter и да се използват във format.

Необработена част от спецификацията, освен спиране на }, изисква std::format_error. Сигнатурата format трябва да работи с изискваната квалификация на стойността и const formatter, за да са форматирани и const стойности по C++23; върнатият итератор трябва да е реалният край на изхода. Разрешена е специализация за програмен тип, но не произволна подмяна на специализации за стандартни типове. Контекстът и итераторите не надживяват извикването.

Примери

#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';
}

Резултат

p=(3, 4)

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

Източници