cppdraft_translate/cppdraft/format/syn.md

[format.syn]

28 Text processing library [text]

28.5 Formatting [format]

28.5.1 Header synopsis [format.syn]

🔗

namespace std {// [format.context], class template basic_format_contexttemplate<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_argstemplate 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_stringtemplate<class charT, class... Args>struct basic_format_string; template struct runtime-format-string { // exposition onlyprivate: basic_string_view str; // exposition onlypublic:runtime-format-string(basic_string_view s) noexcept : str(s) {}runtime-format-string(const runtime-format-string&) = delete; runtime-format-string& operator=(const runtime-format-string&) = delete; }; runtime-format-string runtime_format(string_view fmt) noexcept { return fmt; }runtime-format-string<wchar_t> runtime_format(wstring_view fmt) noexcept { return fmt; }template<class... Args>using format_string = basic_format_string<char, type_identity_t...>; template<class... Args>using wformat_string = basic_format_string<wchar_t, type_identity_t...>; // [format.functions], formatting functionstemplate<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 Out vformat_to(Out out, string_view fmt, format_args args); template Out vformat_to(Out out, wstring_view fmt, wformat_args args); template Out vformat_to(Out out, const locale& loc, string_view fmt, format_args args); template Out vformat_to(Out out, const locale& loc, wstring_view fmt, wformat_args args); template struct format_to_n_result { Out out; iter_difference_t size; }; template<class Out, class... Args> format_to_n_result format_to_n(Out out, iter_difference_t n, format_string<Args...> fmt, Args&&... args); template<class Out, class... Args> format_to_n_result format_to_n(Out out, iter_difference_t n, wformat_string<Args...> fmt, Args&&... args); template<class Out, class... Args> format_to_n_result format_to_n(Out out, iter_difference_t n, const locale& loc, format_string<Args...> fmt, Args&&... args); template<class Out, class... Args> format_to_n_result format_to_n(Out out, iter_difference_t 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], formattertemplate<class T, class charT = char> struct formatter; // [format.formatter.locking], formatter lockingtemplateconstexpr bool enable_nonlocking_formatter_optimization = false; // [format.formattable], concept formattabletemplate<class T, class charT>concept formattable = see below; template<class R, class charT>concept const-formattable-range = // exposition only ranges::input_range &&formattable<ranges::range_reference_t, charT>; template<class R, class charT>using fmt-maybe-const = // exposition only conditional_t<const-formattable-range<R, charT>, const R, R>; // [format.parse.ctx], class template basic_format_parse_contexttemplate class basic_format_parse_context; using format_parse_context = basic_format_parse_context; using wformat_parse_context = basic_format_parse_context<wchar_t>; // [format.range], formatting of ranges// [format.range.fmtkind], variable template format_kindenum class range_format {disabled, map, set, sequence, string, debug_string}; templateconstexpr unspecified format_kind = unspecified; template<ranges::input_range R>requires same_as<R, remove_cvref_t>constexpr range_format format_kind = see below; // [format.range.formatter], class template range_formattertemplate<class T, class charT = char>requires same_as<remove_cvref_t, T> && formattable<T, charT>class range_formatter; // [format.range.fmtdef], class template range-default-formattertemplate<range_format K, ranges::input_range R, class charT>struct range-default-formatter; // exposition only// [format.range.fmtmap], [format.range.fmtset], [format.range.fmtstr], specializations for maps, sets, and stringstemplate<ranges::input_range R, class charT>requires (format_kind != range_format::disabled) &&formattable<ranges::range_reference_t, charT>struct formatter<R, charT> : range-default-formatter<format_kind, R, charT> { }; template<ranges::input_range R>requires (format_kind != range_format::disabled)constexpr bool enable_nonlocking_formatter_optimization = false; // [format.arguments], arguments// [format.arg], class template basic_format_argtemplate class basic_format_arg; // [format.arg.store], class template format-arg-storetemplate<class Context, class... Args> class format-arg-store; // exposition onlytemplateformat-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_errorclass format_error;}

1

#

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.