std::format_to

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) Трёхстороннее сравнение (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)     is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

Общие утилиты Дата и время Функциональные объекты Библиотека форматирования (C++20) bitset hash (C++11) Операторы отношения (устарело в C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Целочисленные функции сравнения cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)     cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Операции обмена и типа swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Общие лексические типы pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

Библиотека форматирования

Функции форматирования

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

Концепты форматирования

formattable (C++23)

Форматировщик

formatter (C++20)

range_formatter (C++23)

basic_format_parse_contextformat_parse_contextwformat_parse_context (C++20)(C++20)(C++20)

basic_format_contextformat_contextwformat_context (C++20)(C++20)(C++20)

range_format (C++23)

format_kind (C++23)

Аргументы форматирования

basic_format_arg (C++20)

basic_format_arg::handle (C++20)

basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)

basic_format_stringformat_stringwformat_string (C++20)(C++20)(C++20)

visit_format_arg (C++20) (устарело в C++26)

make_format_argsmake_wformat_args (C++20)(C++20)

Ошибка формата

format_error (C++20)

 

<tbody> </tbody>

Определено в заголовочном файле <format>
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, std::format_string<Args...> fmt, Args&&... args );	(1)	(начиная с C++20)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, std::wformat_string<Args...> fmt, Args&&... args );	(2)	(начиная с C++20)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc, std::format_string<Args...> fmt, Args&&... args );	(3)	(начиная с C++20)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc, std::wformat_string<Args...> fmt, Args&&... args );	(4)	(начиная с C++20)

Форматирует args в соответствии со строкой формата fmt и записывает результат в итератор вывода out. Если присутствует, loc используется для форматирования, зависящего от локали.

1) эквивалентно return std::vformat_to(out, fmt.str, std::make_format_args(args...));

2) эквивалентно return std::vformat_to(std::move(out), fmt.str, std::make_wformat_args(args...));

3) эквивалентно return std::vformat_to(out, loc, fmt.str, std::make_format_args(args...));

4) эквивалентно return std::vformat_to(std::move(out), loc, fmt.str, std::make_wformat_args(args...));

Пусть CharT будет char для перегрузок (1,3), wchar_t для перегрузок (2,4).

Эти перегрузки участвуют в разрешении перегрузки, только если OutputIt соответствует концепту std::output_iterator<const CharT&>.

Поведение не определено, если OutputIt не моделирует (не отвечает семантическим требованиям) концепт std::output_iterator<const CharT&> или если std::formatter<Ti, CharT> не соответствует требованиям BasicFormatter для любого Ti в Args (как того требуют std::make_format_args и std::make_wformat_args).

Параметры

out	—	итератор выходного буфера
fmt	—	объект, представляющий строку формата. Строка формата состоит из обычных символов (кроме { и }), которые копируются в вывод без изменений, управляющих последовательностей {{ и }}, которые заменяются на { и } соответственно в выводе, и заменяемых полей. Каждое поле замены имеет следующий формат: { идентификатор-аргумента (необязательно) } (1) { идентификатор-аргумента (необязательно) : спецификатор-формата } (2) 1) поле замены без указания формата 2) поле замены со спецификацией формата идентификатор-аргумента — указывает индекс аргумента в args, значение которого должно использоваться для форматирования; если он опущен, аргументы используются по порядку. идентификаторы-аргументов в строке формата должны присутствовать все или быть опущены. Смешение ручной и автоматической индексации является ошибкой. спецификатор-формата — спецификация формата, определённая специализацией std::formatter для соответствующего аргумента. Для базовых типов и стандартных строковых типов спецификация формата интерпретируется как спецификация стандартного формата. Для типов chrono спецификация формата интерпретируется как спецификация формата chrono. Для std::thread::id спецификация формата интерпретируется как спецификация формата идентификатора потока. Для других форматируемых типов спецификация формата определяется определяемыми пользователем специализациями formatter.
args...	—	аргументы для форматирования
loc	—	std::locale используется для форматирования, зависящего от локали

Возвращаемое значение

Итератор за концом выходного диапазона.

Исключения

Распространяет любые исключения, возникающие в результате операций форматирования или итерирования.

Примечание

Начиная с P2216R3, если строка формата не является константным выражением, это ошибка. В этом случае можно использовать std::vformat_to.

Пример

Запустить этот код

#include <format>
#include <iostream>
#include <iterator>
#include <string>

auto main() -> int
{
    std::string buffer;

    std::format_to(
        std::back_inserter(buffer), //< OutputIt
        "Привет, C++{}!\n",          //< fmt 
        "20");                      //< аргумент
    std::cout << buffer;
    buffer.clear();

    std::format_to(
        std::back_inserter(buffer),       //< OutputIt
        "Привет, {0}::{1}!{2}",           //< fmt 
        "std",                            //< аргумент {0}
        "format_to()",                    //< аргумент {1}
        "\n",                             //< аргумент {2}
        "дополнительный параметр(ы)..."); //< не используется
    std::cout << buffer;

    std::wstring wbuffer;
    std::format_to(
        std::back_inserter(wbuffer),//< OutputIt 
        L"Привет, {2}::{1}!{0}",    //< fmt
        L"\n",                      //< аргумент {0}
        L"format_to()",             //< аргумент {1}
        L"std",                     //< аргумент {2}
        L"...это не..."             //< не используется
        L"...ошибка!");             //< не используется
    std::wcout << wbuffer;
}

Вывод:

Привет, C++20!
Привет, std::format_to()!
Привет, std::format_to()!

Отчёты о дефектах

Следующие изменения поведения были применены с обратной силой к ранее опубликованным стандартам C++:

Номер	Применён	Поведение в стандарте	Корректное поведение
WG не указан	C++20	генерирует std::format_error для неверной строки формата	неверная строка формата приводит к ошибке времени компиляции
WG не указан	C++20	объекты, которые не являются ни константными, ни копируемыми (например, объекты, подобные генераторам), не форматируются	разрешено форматирование этих объектов
WG не указан	C++20	для этого средства нет видимого пользователем имени	представлено имя basic_format_string

Смотрите также

format (C++20)	сохраняет форматированное представление аргументов в новой строке (шаблон функции)
format_to_n (C++20)	записывает форматированное представление своих аргументов через итератор вывода, не превышая заданного размера (шаблон функции)