Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / C++

std::formatter: formátovací kontrakt typu

Specializace std::formatter<T, charT> určuje parsování specifikace a zápis hodnoty T.

Verze: 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> z <format> je bod přizpůsobení, který std::format a příbuzné funkce používají pro jeden argument. Formatter splňuje BasicFormatter/Formatter: parse(ctx) zpracuje část za dvojtečkou a vrátí první nespotřebovaný znak, obvykle }, zatímco format(value, ctx) zapisuje přes ctx.out() a vrátí iterátor za výstupem.

Příklad specializuje std::formatter<Point> pro typ programu. parse vrací ctx.begin(), takže přijímá jen prázdnou specifikaci, a format předá zápis souřadnic do std::format_to; výsledkem je p=(3, 4). Specializace musí být viditelná při kontrole literálu. Volby přečtené v parse lze uložit ve formatteru a použít ve format.

Nezpracovaná část specifikace kromě zastavení na } vyžaduje std::format_error. Signatura format má pracovat s požadovanou kvalifikací hodnoty a const formatterem, aby byly v C++23 formátovatelné i const hodnoty; vrácený iterátor musí být skutečný konec výstupu. Specializace je povolena pro typ definovaný programem, ne libovolná náhrada specializací standardních typů. Kontext ani iterátory nepřežívají volání.

Příklady

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

Výsledek

p=(3, 4)

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

Zdroje