Spec-Zone.ru › C++

std::vformat

Определён в заголовочном файле <format>
std::string vformat( std::string_view fmt, std::format_args args );
(1) (начиная с C++20)
std::wstring vformat( std::wstring_view fmt, std::wformat_args args );
(2) (начиная с C++20)
std::string vformat( const std::locale& loc,
                     std::string_view fmt, std::format_args args );
(3) (начиная с C++20)
std::wstring vformat( const std::locale& loc,
                      std::wstring_view fmt, std::wformat_args args );
(4) (начиная с C++20)

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

Параметры

fmt - объект, представляющий строку формата. Строка формата состоит из
  • обычных символов (кроме { и }), которые без изменений копируются в выходные данные,
  • управляющих последовательностей {{ и }}, которые заменяются соответственно на { и } в выходных данных, и
  • полей подстановки.

Каждое поле подстановки имеет следующий формат:

{ arg-id (необязательно) } (1)
{ arg-id (необязательно) : format-spec } (2)
1) поле подстановки без спецификации формата 2) поле подстановки со спецификацией формата
arg-id - задаёт индекс аргумента в args, значение которого используется для форматирования; если он не указан, аргументы используются по порядку.

Все arg-id в строке формата должны быть либо указаны, либо опущены. Смешение ручной и автоматической индексации является ошибкой.

format-spec - спецификация формата, определяемая специализацией std::formatter для соответствующего аргумента. Не может начинаться с }.
  • Для основных типов и стандартных строковых типов спецификация формата интерпретируется как стандартная спецификация формата.
  • Для типов chrono спецификация формата интерпретируется как спецификация формата chrono.
  • Для типов диапазонов спецификация формата интерпретируется как спецификация формата диапазона.
  • Для std::pair и std::tuple спецификация формата интерпретируется как спецификация формата кортежа.
  • Для std::thread::id и std::stacktrace_entry см. спецификацию формата идентификатора потока и спецификацию формата записи трассировки стека.
  • Для std::basic_stacktrace спецификатор формата не допускается.
(начиная с C++23)
  • Для std::filesystem::path см. спецификацию формата пути.
(начиная с C++26)
  • Для других форматируемых типов спецификация формата определяется пользовательскими специализациями formatter.
args - аргументы для форматирования
loc - std::locale, используемый для форматирования с учётом локали

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

Строковый объект, содержащий отформатированный результат.

Исключения

Выбрасывает std::format_error, если fmt не является допустимой строкой формата для переданных аргументов, или std::bad_alloc при сбое выделения памяти. Также передаёт любые исключения, выброшенные операциями форматирования или итератора.

Пример

#include <format>
#include <iostream>

template<typename... Args>
inline void println(const std::format_string<Args...> fmt, Args&&... args)
{
    std::cout << std::vformat(fmt.get(), std::make_format_args(args...)) << '\n';
}

int main()
{
    println("{}{} {}{}", "Hello", ',', "C++", -1 + 2 * 3 * 4);
}

Вывод:

Hello, C++23

См. также

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/utility/format/vformat

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API