20 General utilities library [utilities]

20.20 Formatting [format]

20.20.1 Header <format> synopsis [format.syn]

namespace std { // [format.context], class template basic_­format_­context template<class Out, class charT> class basic_format_context; using format_context = basic_format_context<unspecified, char>; using wformat_context = basic_format_context<unspecified, wchar_t>; // [format.args], class template basic_­format_­args template<class Context> class basic_format_args; using format_args = basic_format_args<format_context>; using wformat_args = basic_format_args<wformat_context>; // [format.fmt.string], class template basic-format-string template<class charT, class... Args> struct basic-format-string; // exposition only template<class... Args> using format-string = // exposition only basic-format-string<char, type_identity_t<Args>...>; template<class... Args> using wformat-string = // exposition only basic-format-string<wchar_t, type_identity_t<Args>...>; // [format.functions], formatting functions template<class... Args> string format(format-string<Args...> fmt, Args&&... args); template<class... Args> wstring format(wformat-string<Args...> fmt, Args&&... args); template<class... Args> string format(const locale& loc, format-string<Args...> fmt, Args&&... args); template<class... Args> wstring format(const locale& loc, wformat-string<Args...> fmt, Args&&... args); string vformat(string_view fmt, format_args args); wstring vformat(wstring_view fmt, wformat_args args); string vformat(const locale& loc, string_view fmt, format_args args); wstring vformat(const locale& loc, wstring_view fmt, wformat_args args); template<class Out, class... Args> Out format_to(Out out, format-string<Args...> fmt, Args&&... args); template<class Out, class... Args> Out format_to(Out out, wformat-string<Args...> fmt, Args&&... args); template<class Out, class... Args> Out format_to(Out out, const locale& loc, format-string<Args...> fmt, Args&&... args); template<class Out, class... Args> Out format_to(Out out, const locale& loc, wformat-string<Args...> fmt, Args&&... args); template<class Out> Out vformat_to(Out out, string_view fmt, format_args args); template<class Out> Out vformat_to(Out out, wstring_view fmt, wformat_args args); template<class Out> Out vformat_to(Out out, const locale& loc, string_view fmt, format_args args); template<class Out> Out vformat_to(Out out, const locale& loc, wstring_view fmt, wformat_args args); template<class Out> struct format_to_n_result { Out out; iter_difference_t<Out> size; }; template<class Out, class... Args> format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n, format-string<Args...> fmt, Args&&... args); template<class Out, class... Args> format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n, wformat-string<Args...> fmt, Args&&... args); template<class Out, class... Args> format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n, const locale& loc, format-string<Args...> fmt, Args&&... args); template<class Out, class... Args> format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n, const locale& loc, wformat-string<Args...> fmt, Args&&... args); template<class... Args> size_t formatted_size(format-string<Args...> fmt, Args&&... args); template<class... Args> size_t formatted_size(wformat-string<Args...> fmt, Args&&... args); template<class... Args> size_t formatted_size(const locale& loc, format-string<Args...> fmt, Args&&... args); template<class... Args> size_t formatted_size(const locale& loc, wformat-string<Args...> fmt, Args&&... args); // [format.formatter], formatter template<class T, class charT = char> struct formatter; // [format.parse.ctx], class template basic_­format_­parse_­context template<class charT> class basic_format_parse_context; using format_parse_context = basic_format_parse_context<char>; using wformat_parse_context = basic_format_parse_context<wchar_t>; // [format.arguments], arguments // [format.arg], class template basic_­format_­arg template<class Context> class basic_format_arg; template<class Visitor, class Context> decltype(auto) visit_format_arg(Visitor&& vis, basic_format_arg<Context> arg); // [format.arg.store], class template format-arg-store template<class Context, class... Args> class format-arg-store; // exposition only template<class Context = format_context, class... Args> format-arg-store<Context, Args...> make_format_args(Args&&... fmt_args); template<class... Args> format-arg-store<wformat_context, Args...> make_wformat_args(Args&&... args); // [format.error], class format_­error class format_error; }
The class template format_­to_­n_­result has the template parameters, data members, and special members specified above.
It has no base classes or members other than those specified.