std::format_to_n

De cppreference.com

Definido en el archivo de encabezado `<format>`
template<class OutputIt, class... Args> std::format_to_n_result<OutputIt> format_to_n(OutputIt out, std::iter_difference_t<OutputIt> n, std::string_view fmt, const Args&... args);	(1)	(desde C++20)
template<class OutputIt, class... Args> std::format_to_n_result<OutputIt> format_to_n(OutputIt out, std::iter_difference_t<OutputIt> n, std::wstring_view fmt, const Args&... args);	(2)	(desde C++20)
template<class OutputIt, class... Args> std::format_to_n_result<OutputIt> format_to_n(OutputIt out, std::iter_difference_t<OutputIt> n, const std::locale& loc, std::string_view fmt, const Args&... args);	(3)	(desde C++20)
template<class OutputIt, class... Args> std::format_to_n_result<OutputIt> format_to_n(OutputIt out, std::iter_difference_t<OutputIt> n, const std::locale& loc, std::wstring_view fmt, const Args&... args);	(4)	(desde C++20)
template<class OutputIt> struct format_to_n_result { OutputIt out; std::iter_difference_t<OutputIt> size; };	(5)	(desde C++20)

Formatea a args de acuerdo a la cadena de formato fmt, y escribe el resultado al iterador de salida out. Se escriben n caracteres como máximo. 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.

5) std::format_to_n_result no tiene clases base u otros miembros, excepto out, size, y las funciones miembro especiales declaradas implícitamente.

[editar] Parámetros

out - Iterador al búfer de salida.

n - Número máximo de caracteres a ser escritos al búfer.

fmt

Vista sobre cadena que representa la cadena de formato.

[edit]

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.

[editar] Valor de retorno

Un format_to_n_result tal que el miembro out es un iterador después del final del rango de salida, y el miembro size es el tamaño de la salida (no truncada).

[editar] 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.

[editar] Ejemplo

Ejecuta este código

#include <format>
#include <string_view>
#include <iostream>
 
int main()
{
    char buffer[64];
 
    const auto result =
        std::format_to_n(buffer, std::size(buffer), 
                         "Hubble's H{0} {1} {2} km/sec/mpc.",
                         "\u2080", "\u2245", 71);
 
    std::cout << "Búfer: \"" << std::string_view{buffer, result.size} << "\"\n"
              << "Tamaño del búfer = " << std::size(buffer) << '\n'
              << "Tamaño de la salida sin truncar = " << result.size << '\n';
}

Salida:

Búfer: "Hubble's H₀ ≅ 71 km/sec/mpc."
Tamaño del búfer = 64
Tamaño de la salida sin truncar = 35

[editar] Véase también

format (C++20)	Almacena una representación formateada de los argumentos en una cadena nueva. (plantilla de función) [editar]
format_to (C++20)	Escribe una representación formateada de sus argumentos mediante un iterador de salida. (plantilla de función) [editar]
formatted_size (C++20)	Determina el número de caracteres necesario para almacenar la representación formateada de sus argumentos. (plantilla de función) [editar]

Obtenido de «https://es.cppreference.com/mwiki/index.php?title=cpp/utility/format/format_to_n&oldid=37771»

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

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)

cppreference.com

Espacios de nombres

Variantes

Vistas

Acciones