std::format_to

 

C++

Apoyo de compiladores

Implementaciones independientes y albergadas

Lenguaje

Biblioteca estándar

Encabezados de la biblioteca estándar

Requisitos denominados

Macros de prueba de característica (C++20)

Biblioteca de apoyo del lenguaje

Biblioteca de conceptos (C++20)

Biblioteca de diagnósticos

Biblioteca de gestión de memoria

Biblioteca de metaprogramación (C++11)

Biblioteca de servicios generales

Biblioteca de contenedores

Biblioteca de iteradores

Biblioteca de rangos (C++20)

Biblioteca de algoritmos

Biblioteca de cadenas

Biblioteca de procesamiento de texto

Biblioteca numérica

Biblioteca de fecha y hora

Biblioteca de entrada/salida

Biblioteca del sistema de archivos (C++17)

Biblioteca de apoyo de concurrencia (C++11)

Biblioteca de apoyo de ejecución (C++26)

Especificaciones técnicas

Índice de símbolos

Bibliotecas externas

 

Biblioteca de servicios

Apoyo del lenguaje Apoyo de tipos (tipos básicos, RTTI) Biblioteca de macros de prueba de característica (C++20) Servicios del programa Apoyo de corrutinas (C++20) Funciones variádicas is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) Comparación de tres vías 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_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

Servicios generales Objetos función Manipulación de bits (C++20) bitset hash (C++11) Operadores relacionales (en desuso en C++20) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= Funciones de comparación de enteros 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) Intercambio y operaciones de tipos 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) Tipos vocabulario comunes 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)

 

Biblioteca de formato

Funciones de formato

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

Formateador

formatter (C++20)

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)

Argumentos de formato

basic_format_arg (C++20)

basic_format_argsformat_argswformat_argsformat_args_t (C++20)(C++20)(C++20)(C++20)

visit_format_arg (C++20)

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

Error de formato

format_error (C++20)

 

Definido en el archivo de encabezado <format>
template<class OutputIt, class... Args> OutputIt format_to(OutputIt out, std::string_view fmt, const Args&... args);	(1)	(desde C++20)
template<class OutputIt, class... Args> OutputIt format_to(OutputIt out, std::wstring_view fmt, const Args&... args);	(2)	(desde C++20)
template<class OutputIt, class... Args> OutputIt format_to(OutputIt out, const std::locale& loc, std::string_view fmt, const Args&... args);	(3)	(desde C++20)
template<class OutputIt, class... Args> OutputIt format_to(OutputIt out, const std::locale& loc, std::wstring_view fmt, const Args&... args);	(4)	(desde C++20)

Formatea a args de acuerdo a la cadena de formato fmt, y escribe el resultado al iterador de salida out. Si está presente, se usa loc para un formato específico de la configuración regional.

Dejemos que CharT sea decltype(fmt)::char_type (char para las sobrecargas (1,3), wchar_t para las sobrecargas (2,4)).

Estas sobrecargas solo participan en la resolución de sobrecargas si OutputIt satisface el concepto std::output_iterator<const CharT&>.

El comportamiento no está definido si OutputIt no modela (cumple con los requerimientos semánticos de) el concepto std::output_iterator<const CharT&>, o si std::formatter<Ti, CharT> no cumple con los requerimientos de Formatter para cualquier Ti en Args.

Parámetros

out	-	Iterador al búfer de salida.
fmt	-	Vista sobre cadena que representa la cadena de formato. Un objeto que representa la cadena de formato. La cadena de formato consiste en: caracteres ordinarios (excepto { y }), que se copian sin cambiarse a la salida, secuencias de escape {{ y }}, que se reemplazan con { y }, respectivamente en la salida, y campos de reemplazo. Cada campo de reemplazo tiene el siguiente formato: un carácter { introductorio; (opcional) arg-id, un número no negativo; (opcional) dos puntos (:) seguido de una especificación de formato; un carácter } final. arg-id especifica el índice del argumento en args cuyo valor se usará para formatear; si se omite arg-id, los argumentos se usan en orden. Los arg-ids en una cadena de formato tienen que estar presentes o todos deben de omitirse. Mezclar la indexación manual y automática es un error. La especificación de formato se define por la especialización de std::formatter del argumento correspondiente. Para los tipos básicos y los tipos de cadena estándar, la especificación de formato se interpreta como la especificación de formato estándar. Para los tipos chrono, la especificación de formato se interpreta como especificación de formato chrono. Para los tipos rango, la especificación de formato se interpreta como especificación de formato para rangos. Para std::pair y std::tuple, la especificación de formato se interpreta como especificación de formato para tuplas. Para std::thread::id y std::stacktrace_entry, véase la especificación de formato para identificador de hilos y la especificación de formato para una entrada del listado de pila. Para std::basic_stacktrace, no se permite un especificador de formato. (desde C++23) Para std::filesystem::path, véase la especificación de formato para ruta de acceso. (desde C++26) Para los otros tipos formateables, la especificación de formato se determina por especializaciones de formatter definidas por el usuario.
args...	-	Argumentos a ser formateados.
loc	-	std::locale usado para un formato específico de la configuración regional.

Valor de retorno

Un iterador después del final del rango de salida.

Excepciones

Lanza std::format_error si fmt no es una cadena de formato válida para los argumentos proporcionados. También propaga cualquier excepción lanzada por el formateador o las operaciones del iterador.

Ejemplo

Ejecuta este código

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

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

    std::format_to(
        std::back_inserter(buffer), //< OutputIt
        "¡Hola, C++{}!\n",          //< fmt 
        "20");                      //< arg
    std::cout << buffer;
    buffer.clear();

    std::format_to(
        std::back_inserter(buffer), //< OutputIt
        "¡Hola, {0}::{1}!{2}",      //< fmt 
        "std",                      //< arg {0}
        "format_to()",              //< arg {1}
        "\n",                       //< arg {2}
        "param(s) extra...");       //< no se usa
    std::cout << buffer;

    std::wstring wbuffer;
    std::format_to(
        std::back_inserter(wbuffer),//< OutputIt 
        L"¡Hola, {2}::{1}!{0}",     //< fmt
        L"\n",                      //< arg {0}
        L"format_to()",             //< arg {1}
        L"std",                     //< arg {2}
        L"...no es..."              //< no se usa
        L"...un error!");           //< no se usa
    std::wcout << wbuffer;
}

Salida:

¡Hola, C++20!
¡Hola, std::format_to()!
¡Hola, std::format_to()!

Véase también

format (C++20)	Almacena una representación formateada de los argumentos en una cadena nueva. (plantilla de función)
format_to_n (C++20)	Escribe una representación formateada de sus argumentos mediante un iterador de salida, no excediendo un tamaño específico. (plantilla de función)