= Reference :mrdocs: == Namespaces [cols=1] |=== | Name | link:#fmt[`fmt`] |=== == link:#fmt[fmt] namespace === Namespaces [cols=1] |=== | Name | link:#fmt-enums[`enums`] | link:#fmt-safe_duration_cast[`safe_duration_cast`] |=== === Types [cols=2] |=== | Name | Description | link:#fmt-basic_appender[`basic_appender`] | | link:#fmt-basic_cstring_view[`basic_cstring_view`] | A reference to a null‐terminated string. It can be constructed from a C string or `std::string`. | link:#fmt-basic_format_arg[`basic_format_arg`] | | link:#fmt-basic_format_args[`basic_format_args`] | A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: | link:#fmt-basic_fstring[`basic_fstring`] | | link:#fmt-basic_memory_buffer[`basic_memory_buffer`] | A dynamically growing memory buffer for trivially copyable/constructible types with the first `SIZE` elements stored in the object itself. Most commonly used via the `memory_buffer` alias for `char`. | link:#fmt-basic_ostream_formatter[`basic_ostream_formatter`] | | link:#fmt-basic_printf_context[`basic_printf_context`] | | link:#fmt-basic_specs[`basic_specs`] | | link:#fmt-basic_string_view[`basic_string_view`] | An implementation of `std::basic_string_view` for pre‐C++17. It provides a subset of the API. `fmt::basic_string_view` is used for format strings even if `std::basic_string_view` is available to prevent issues when a library is compiled with a different `‐std` option than the client code (which is not recommended). | link:#fmt-buffered_file[`buffered_file`] | | link:#fmt-bytes[`bytes`] | | link:#fmt-compiled_string[`compiled_string`] | | link:#fmt-conjunction-0d[`conjunction`] | | link:#fmt-conjunction-05[`conjunction<P>`] | | link:#fmt-conjunction-0f[`conjunction<P1, Pn...>`] | | link:#fmt-context[`context`] | | link:#fmt-day[`day`] | | link:#fmt-dynamic_format_arg_store[`dynamic_format_arg_store`] | A dynamic list of formatting arguments with storage. | link:#fmt-file[`file`] | | link:#fmt-format_error[`format_error`] | An error reported from a formatting function. | link:#fmt-format_facet-0ca[`format_facet`] | | link:#fmt-format_facet-0c5[`format_facet<locale>`] | | link:#fmt-format_int[`format_int`] | A fast integer formatter. | link:#fmt-format_specs[`format_specs`] | | link:#fmt-format_to_n_result[`format_to_n_result`] | | link:#fmt-format_to_result[`format_to_result`] | | link:#fmt-formatter-02b[`formatter`] | | link:#fmt-formatter-01c[`formatter</* implementation-defined */>`] | | link:#fmt-formatter-012[`formatter<bytes>`] | | link:#fmt-formatter-07[`formatter<std::error_code>`] | | link:#fmt-formatter-050[`formatter<std::source_location>`] | | link:#fmt-formatter-09e[`formatter<std::type_info>`] | | link:#fmt-formatter-0ee[`formatter<group_digits_view<T>>`] | | link:#fmt-formatter-0c4[`formatter<T, char>`] | | link:#fmt-formatter-03a[`formatter<std::atomic_flag, Char>`] | | link:#fmt-formatter-0cee[`formatter<std::byte, Char>`] | | link:#fmt-formatter-0a5[`formatter<day, Char>`] | | link:#fmt-formatter-024[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-026[`formatter<std::thread::id, Char>`] | | link:#fmt-formatter-0ef[`formatter<std::monostate, Char>`] | | link:#fmt-formatter-009b[`formatter<month, Char>`] | | link:#fmt-formatter-095[`formatter<std::nullptr_t, Char>`] | | link:#fmt-formatter-049[`formatter<std::filesystem::path, Char>`] | | link:#fmt-formatter-0626[`formatter<tm, Char>`] | | link:#fmt-formatter-018e[`formatter<weekday, Char>`] | | link:#fmt-formatter-02a[`formatter<year, Char>`] | | link:#fmt-formatter-0c6[`formatter<year_month_day, Char>`] | | link:#fmt-formatter-022[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-01a[`formatter<signed char, Char>`] | | link:#fmt-formatter-0a3[`formatter<unsigned char, Char>`] | | link:#fmt-formatter-0a2[`formatter<short, Char>`] | | link:#fmt-formatter-0cf[`formatter<unsigned short, Char>`] | | link:#fmt-formatter-09c6[`formatter<long, Char>`] | | link:#fmt-formatter-08e[`formatter<unsigned long, Char>`] | | link:#fmt-formatter-00b[`formatter<Char*, Char>`] | | link:#fmt-formatter-0b30[`formatter<void*, Char>`] | | link:#fmt-formatter-0b0[`formatter<BitRef, Char>`] | | link:#fmt-formatter-018b[`formatter<R, Char>`] | | link:#fmt-formatter-0097[`formatter<R, Char>`] | | link:#fmt-formatter-032[`formatter<R, Char>`] | | link:#fmt-formatter-0627[`formatter<T, Char>`] | | link:#fmt-formatter-003[`formatter<T, Char>`] | | link:#fmt-formatter-0d1[`formatter<Tuple, Char>`] | | link:#fmt-formatter-005[`formatter<Variant, Char>`] | | link:#fmt-formatter-0d6[`formatter<std::atomic<T>, Char>`] | | link:#fmt-formatter-0f[`formatter<std::bitset<N>, Char>`] | | link:#fmt-formatter-0a8[`formatter<std::complex<T>, Char>`] | | link:#fmt-formatter-084[`formatter<local_time<Duration>, Char>`] | | link:#fmt-formatter-040[`formatter<nested_view<T, Char>, Char>`] | | link:#fmt-formatter-09c3[`formatter<std::optional<T>, Char>`] | | link:#fmt-formatter-0b3b[`formatter<std::reference_wrapper<T>, Char>`] | | link:#fmt-formatter-09c7[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-094[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-09d[`formatter<sys_time<Duration>, Char>`] | | link:#fmt-formatter-08f[`formatter<tuple_join_view<Tuple, Char>, Char>`] | | link:#fmt-formatter-0516e9[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-0516e8[`formatter<utc_time<Duration>, Char>`] | | link:#fmt-formatter-0ce9[`formatter<Char[], Char>`] | | link:#fmt-formatter-043[`formatter<std::basic_string<Char, Traits, Allocator>, Char>`] | | link:#fmt-formatter-03b[`formatter<std::chrono::duration<Rep, Period>, Char>`] | | link:#fmt-formatter-0bc[`formatter<std::expected<T, E>, Char>`] | | link:#fmt-formatter-000[`formatter<join_view<It, Sentinel, Char>, Char>`] | | link:#fmt-formatter-093[`formatter<T, Char, void_t</* implementation-defined */>>`] | | link:#fmt-fstring[`fstring`] | A compile‐time format string. Use `format_string` in the public API to prevent type deduction. | link:#fmt-generic_context[`generic_context`] | | link:#fmt-group_digits_view[`group_digits_view`] | | link:#fmt-is_compiled_string[`is_compiled_string`] | | link:#fmt-is_contiguous-05[`is_contiguous`] | | link:#fmt-is_contiguous-0a[`is_contiguous<basic_memory_buffer<T, SIZE, Allocator>>`] | | link:#fmt-is_contiguous-0e[`is_contiguous<std::basic_string<Char, Traits, Allocator>>`] | | link:#fmt-is_range[`is_range`] | | link:#fmt-is_tuple_formattable[`is_tuple_formattable`] | | link:#fmt-is_tuple_like[`is_tuple_like`] | | link:#fmt-is_variant_like[`is_variant_like`] | | link:#fmt-join_view[`join_view`] | | link:#fmt-loc_value[`loc_value`] | | link:#fmt-locale_ref[`locale_ref`] | | link:#fmt-monostate[`monostate`] | | link:#fmt-month[`month`] | | link:#fmt-nested_formatter[`nested_formatter`] | | link:#fmt-nested_view[`nested_view`] | | link:#fmt-parse_context-0f[`parse_context`] | Parsing context consisting of a format string range being parsed and an argument counter for automatic indexing. | link:#fmt-parse_context-00[`parse_context<char>`] | | link:#fmt-path[`path`] | | link:#fmt-range_format_kind[`range_format_kind`] | | link:#fmt-range_formatter-00[`range_formatter`] | | link:#fmt-range_formatter-07[`range_formatter<T, Char>`] | | link:#fmt-rgb[`rgb`] | | link:#fmt-runtime_format_string[`runtime_format_string`] | | link:#fmt-static_format_result[`static_format_result`] | | link:#fmt-string_buffer[`string_buffer`] | | link:#fmt-text_style[`text_style`] | A text style consisting of foreground and background colors and emphasis. | link:#fmt-tuple_join_view[`tuple_join_view`] | | link:#fmt-vprintf_args[`vprintf_args`] | | link:#fmt-weekday[`weekday`] | | link:#fmt-writer[`writer`] | | link:#fmt-year[`year`] | | link:#fmt-year_month_day[`year_month_day`] | | link:#fmt-appender[`appender`] | | link:#fmt-basic_format_context[`basic_format_context`] | | link:#fmt-basic_format_parse_context[`basic_format_parse_context`] | | link:#fmt-basic_format_string[`basic_format_string`] | | link:#fmt-bool_constant[`bool_constant`] | | link:#fmt-buffered_context[`buffered_context`] | | link:#fmt-conditional_t[`conditional_t`] | | link:#fmt-cstring_view[`cstring_view`] | | link:#fmt-decay_t[`decay_t`] | | link:#fmt-enable_if_t[`enable_if_t`] | | link:#fmt-format_args[`format_args`] | | link:#fmt-format_context[`format_context`] | | link:#fmt-format_parse_context[`format_parse_context`] | | link:#fmt-format_string[`format_string`] | | link:#fmt-is_formattable[`is_formattable`] | | link:#fmt-local_time[`local_time`] | | link:#fmt-make_unsigned_t[`make_unsigned_t`] | | link:#fmt-memory_buffer[`memory_buffer`] | | link:#fmt-nullptr_t[`nullptr_t`] | | link:#fmt-ostream_formatter[`ostream_formatter`] | | link:#fmt-printf_args[`printf_args`] | | link:#fmt-printf_context[`printf_context`] | | link:#fmt-remove_const_t[`remove_const_t`] | | link:#fmt-remove_cvref_t[`remove_cvref_t`] | | link:#fmt-remove_reference_t[`remove_reference_t`] | | link:#fmt-string_view[`string_view`] | | link:#fmt-sys_time[`sys_time`] | | link:#fmt-underlying_t[`underlying_t`] | | link:#fmt-utc_time[`utc_time`] | | link:#fmt-vargs[`vargs`] | | link:#fmt-void_t[`void_t`] | | link:#fmt-wcstring_view[`wcstring_view`] | | link:#fmt-wformat_args[`wformat_args`] | | link:#fmt-wformat_context[`wformat_context`] | | link:#fmt-wformat_parse_context[`wformat_parse_context`] | | link:#fmt-wformat_string[`wformat_string`] | | link:#fmt-wmemory_buffer[`wmemory_buffer`] | | link:#fmt-wprintf_args[`wprintf_args`] | | link:#fmt-wprintf_context[`wprintf_context`] | | link:#fmt-wstring_view[`wstring_view`] | |=== === Enums [cols=1] |=== | Name | link:#fmt-_04enum[`Unnamed enum`] | link:#fmt-align[`align`] | link:#fmt-arg_id_kind[`arg_id_kind`] | link:#fmt-color[`color`] | link:#fmt-emphasis[`emphasis`] | link:#fmt-presentation_type[`presentation_type`] | link:#fmt-range_format[`range_format`] | link:#fmt-sign[`sign`] | link:#fmt-terminal_color[`terminal_color`] |=== === Functions [cols=2] |=== | Name | Description | link:#fmt-2function-0a[`Unnamed overloads`] | | link:#fmt-arg[`arg`] | Returns a named argument to be used in a formatting function. It should only be used in a call to a formatting function. | link:#fmt-assert_fail[`assert_fail`] | | link:#fmt-bg[`bg`] | Creates a text style from the background color. | link:#fmt-fg[`fg`] | Creates a text style from the foreground (text) color. | link:#fmt-format-02[`format`] | `format` overloads | link:#fmt-format_system_error[`format_system_error`] | Formats an error message for an error returned by an operating system or a language runtime, for example a file opening error, and writes it to `out`. The format is the same as the one used by `std::system_error(ec, message)` where `ec` is `std::error_code(error_code, std::generic_category())`. It is implementation‐defined but normally looks like: | link:#fmt-format_to-0da[`format_to`] | `format_to` overloads | link:#fmt-format_to_n-0b[`format_to_n`] | Formats `args` according to specifications in `fmt`, writes up to `n` characters of the result to the output iterator `out` and returns the total (not truncated) output size and the iterator past the end of the output range. `format_to_n` does not append a terminating null character. | link:#fmt-formatted_size-0e2[`formatted_size`] | Returns the number of chars in the output of `format(fmt, args...)`. | link:#fmt-fprintf-0b2[`fprintf`] | Formats `args` according to specifications in `fmt` and writes the output to `f`. | link:#fmt-gmtime-03[`gmtime`] | Converts given time since epoch as `std::time_t` value into calendar time, expressed in Coordinated Universal Time (UTC). Unlike `std::gmtime`, this function is thread‐safe on most platforms. | link:#fmt-group_digits[`group_digits`] | Returns a view that formats an integer value using ',' as a locale‐independent thousands separator. | link:#fmt-join-038[`join`] | `join` overloads | link:#fmt-make_format_args[`make_format_args`] | | link:#fmt-make_printf_args[`make_printf_args`] | Constructs an `format_arg_store` object that contains references to arguments and can be implicitly converted to `printf_args`. | link:#fmt-make_wformat_args[`make_wformat_args`] | | link:#fmt-max_of[`max_of`] | | link:#fmt-min_of[`min_of`] | | link:#fmt-operator_bitor-08[`operator|`] | Bitwise disjunction operators | link:#fmt-print-02[`print`] | `print` overloads | link:#fmt-printf[`printf`] | Formats `args` according to specifications in `fmt` and writes the output to `stdout`. | link:#fmt-println-0d[`println`] | `println` overloads | link:#fmt-ptr-06[`ptr`] | Converts `p` to `const void*` for pointer formatting. | link:#fmt-report_error[`report_error`] | Reports a format error at compile time or, via a `format_error` exception, at runtime. | link:#fmt-report_system_error[`report_system_error`] | | link:#fmt-runtime-0c[`runtime`] | Creates a runtime format string. | link:#fmt-sprintf-05[`sprintf`] | Formats `args` according to specifications in `fmt` and returns the result as as string. | link:#fmt-streamed[`streamed`] | Returns a view that formats `value` via an ostream `operator<<`. | link:#fmt-styled[`styled`] | Returns an argument that will be formatted using ANSI escape sequences, to be used in a formatting function. | link:#fmt-system_category[`system_category`] | | link:#fmt-system_error[`system_error`] | Constructs `std::system_error` with a message formatted with `fmt::format(fmt, args...)`. `error_code` is a system error code as given by `errno`. | link:#fmt-to_string-0bf[`to_string`] | Converts `value` to `std::string` using the default format for type `T`. | link:#fmt-to_wstring[`to_wstring`] | Converts `value` to `std::wstring` using the default format for type `T`. | link:#fmt-underlying[`underlying`] | Converts `e` to the underlying type. | link:#fmt-vformat-02[`vformat`] | | link:#fmt-vformat_to-0b[`vformat_to`] | `vformat_to` overloads | link:#fmt-vformat_to_n-01[`vformat_to_n`] | | link:#fmt-vfprintf[`vfprintf`] | | link:#fmt-vprint-007[`vprint`] | | link:#fmt-vprint_buffered[`vprint_buffered`] | | link:#fmt-vprintln[`vprintln`] | | link:#fmt-vsprintf[`vsprintf`] | | link:#fmt-vsystem_error[`vsystem_error`] | | link:#fmt-operator_eq[`operator==`] | Equality operator | link:#fmt-operator_not_eq[`operator!=`] | Inequality operator | link:#fmt-operator_lt[`operator<`] | Less‐than operator | link:#fmt-operator_le[`operator<=`] | Less‐than‐or‐equal operator | link:#fmt-operator_gt[`operator>`] | Greater‐than operator | link:#fmt-operator_ge[`operator>=`] | Greater‐than‐or‐equal operator |=== === Concepts [cols=1] |=== | Name | link:#fmt-formattable[`formattable`] |=== == link:#fmt-enums[fmt::enums] namespace === Functions [cols=1] |=== | Name | link:#fmt-enums-format_as[`format_as`] |=== == link:#fmt-safe_duration_cast[fmt::safe_duration_cast] namespace === Functions [cols=2] |=== | Name | Description | link:#fmt-safe_duration_cast-lossless_integral_conversion-02[`lossless_integral_conversion`] | Converts From to To, without loss. If the dynamic value of from can't be converted to To without loss, ec is set. | link:#fmt-safe_duration_cast-safe_duration_cast[`safe_duration_cast`] | Safe duration_cast between floating point durations | link:#fmt-safe_duration_cast-safe_float_conversion-05[`safe_float_conversion`] | converts From to To if possible, otherwise ec is set. |=== == Namespaces [cols=1] |=== | Name | link:#fmt-enums[`enums`] | link:#fmt-safe_duration_cast[`safe_duration_cast`] |=== == Types [cols=2] |=== | Name | Description | link:#fmt-basic_appender[`basic_appender`] | | link:#fmt-basic_cstring_view[`basic_cstring_view`] | A reference to a null‐terminated string. It can be constructed from a C string or `std::string`. | link:#fmt-basic_format_arg[`basic_format_arg`] | | link:#fmt-basic_format_args[`basic_format_args`] | A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: | link:#fmt-basic_fstring[`basic_fstring`] | | link:#fmt-basic_memory_buffer[`basic_memory_buffer`] | A dynamically growing memory buffer for trivially copyable/constructible types with the first `SIZE` elements stored in the object itself. Most commonly used via the `memory_buffer` alias for `char`. | link:#fmt-basic_ostream_formatter[`basic_ostream_formatter`] | | link:#fmt-basic_printf_context[`basic_printf_context`] | | link:#fmt-basic_specs[`basic_specs`] | | link:#fmt-basic_string_view[`basic_string_view`] | An implementation of `std::basic_string_view` for pre‐C++17. It provides a subset of the API. `fmt::basic_string_view` is used for format strings even if `std::basic_string_view` is available to prevent issues when a library is compiled with a different `‐std` option than the client code (which is not recommended). | link:#fmt-buffered_file[`buffered_file`] | | link:#fmt-bytes[`bytes`] | | link:#fmt-compiled_string[`compiled_string`] | | link:#fmt-conjunction-0d[`conjunction`] | | link:#fmt-conjunction-05[`conjunction<P>`] | | link:#fmt-conjunction-0f[`conjunction<P1, Pn...>`] | | link:#fmt-context[`context`] | | link:#fmt-day[`day`] | | link:#fmt-dynamic_format_arg_store[`dynamic_format_arg_store`] | A dynamic list of formatting arguments with storage. | link:#fmt-file[`file`] | | link:#fmt-format_error[`format_error`] | An error reported from a formatting function. | link:#fmt-format_facet-0ca[`format_facet`] | | link:#fmt-format_facet-0c5[`format_facet<locale>`] | | link:#fmt-format_int[`format_int`] | A fast integer formatter. | link:#fmt-format_specs[`format_specs`] | | link:#fmt-format_to_n_result[`format_to_n_result`] | | link:#fmt-format_to_result[`format_to_result`] | | link:#fmt-formatter-02b[`formatter`] | | link:#fmt-formatter-01c[`formatter</* implementation-defined */>`] | | link:#fmt-formatter-012[`formatter<bytes>`] | | link:#fmt-formatter-07[`formatter<std::error_code>`] | | link:#fmt-formatter-050[`formatter<std::source_location>`] | | link:#fmt-formatter-09e[`formatter<std::type_info>`] | | link:#fmt-formatter-0ee[`formatter<group_digits_view<T>>`] | | link:#fmt-formatter-0c4[`formatter<T, char>`] | | link:#fmt-formatter-03a[`formatter<std::atomic_flag, Char>`] | | link:#fmt-formatter-0cee[`formatter<std::byte, Char>`] | | link:#fmt-formatter-0a5[`formatter<day, Char>`] | | link:#fmt-formatter-024[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-026[`formatter<std::thread::id, Char>`] | | link:#fmt-formatter-0ef[`formatter<std::monostate, Char>`] | | link:#fmt-formatter-009b[`formatter<month, Char>`] | | link:#fmt-formatter-095[`formatter<std::nullptr_t, Char>`] | | link:#fmt-formatter-049[`formatter<std::filesystem::path, Char>`] | | link:#fmt-formatter-0626[`formatter<tm, Char>`] | | link:#fmt-formatter-018e[`formatter<weekday, Char>`] | | link:#fmt-formatter-02a[`formatter<year, Char>`] | | link:#fmt-formatter-0c6[`formatter<year_month_day, Char>`] | | link:#fmt-formatter-022[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-01a[`formatter<signed char, Char>`] | | link:#fmt-formatter-0a3[`formatter<unsigned char, Char>`] | | link:#fmt-formatter-0a2[`formatter<short, Char>`] | | link:#fmt-formatter-0cf[`formatter<unsigned short, Char>`] | | link:#fmt-formatter-09c6[`formatter<long, Char>`] | | link:#fmt-formatter-08e[`formatter<unsigned long, Char>`] | | link:#fmt-formatter-00b[`formatter<Char*, Char>`] | | link:#fmt-formatter-0b30[`formatter<void*, Char>`] | | link:#fmt-formatter-0b0[`formatter<BitRef, Char>`] | | link:#fmt-formatter-018b[`formatter<R, Char>`] | | link:#fmt-formatter-0097[`formatter<R, Char>`] | | link:#fmt-formatter-032[`formatter<R, Char>`] | | link:#fmt-formatter-0627[`formatter<T, Char>`] | | link:#fmt-formatter-003[`formatter<T, Char>`] | | link:#fmt-formatter-0d1[`formatter<Tuple, Char>`] | | link:#fmt-formatter-005[`formatter<Variant, Char>`] | | link:#fmt-formatter-0d6[`formatter<std::atomic<T>, Char>`] | | link:#fmt-formatter-0f[`formatter<std::bitset<N>, Char>`] | | link:#fmt-formatter-0a8[`formatter<std::complex<T>, Char>`] | | link:#fmt-formatter-084[`formatter<local_time<Duration>, Char>`] | | link:#fmt-formatter-040[`formatter<nested_view<T, Char>, Char>`] | | link:#fmt-formatter-09c3[`formatter<std::optional<T>, Char>`] | | link:#fmt-formatter-0b3b[`formatter<std::reference_wrapper<T>, Char>`] | | link:#fmt-formatter-09c7[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-094[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-09d[`formatter<sys_time<Duration>, Char>`] | | link:#fmt-formatter-08f[`formatter<tuple_join_view<Tuple, Char>, Char>`] | | link:#fmt-formatter-0516e9[`formatter</* implementation-defined */, Char>`] | | link:#fmt-formatter-0516e8[`formatter<utc_time<Duration>, Char>`] | | link:#fmt-formatter-0ce9[`formatter<Char[], Char>`] | | link:#fmt-formatter-043[`formatter<std::basic_string<Char, Traits, Allocator>, Char>`] | | link:#fmt-formatter-03b[`formatter<std::chrono::duration<Rep, Period>, Char>`] | | link:#fmt-formatter-0bc[`formatter<std::expected<T, E>, Char>`] | | link:#fmt-formatter-000[`formatter<join_view<It, Sentinel, Char>, Char>`] | | link:#fmt-formatter-093[`formatter<T, Char, void_t</* implementation-defined */>>`] | | link:#fmt-fstring[`fstring`] | A compile‐time format string. Use `format_string` in the public API to prevent type deduction. | link:#fmt-generic_context[`generic_context`] | | link:#fmt-group_digits_view[`group_digits_view`] | | link:#fmt-is_compiled_string[`is_compiled_string`] | | link:#fmt-is_contiguous-05[`is_contiguous`] | | link:#fmt-is_contiguous-0a[`is_contiguous<basic_memory_buffer<T, SIZE, Allocator>>`] | | link:#fmt-is_contiguous-0e[`is_contiguous<std::basic_string<Char, Traits, Allocator>>`] | | link:#fmt-is_range[`is_range`] | | link:#fmt-is_tuple_formattable[`is_tuple_formattable`] | | link:#fmt-is_tuple_like[`is_tuple_like`] | | link:#fmt-is_variant_like[`is_variant_like`] | | link:#fmt-join_view[`join_view`] | | link:#fmt-loc_value[`loc_value`] | | link:#fmt-locale_ref[`locale_ref`] | | link:#fmt-monostate[`monostate`] | | link:#fmt-month[`month`] | | link:#fmt-nested_formatter[`nested_formatter`] | | link:#fmt-nested_view[`nested_view`] | | link:#fmt-parse_context-0f[`parse_context`] | Parsing context consisting of a format string range being parsed and an argument counter for automatic indexing. | link:#fmt-parse_context-00[`parse_context<char>`] | | link:#fmt-path[`path`] | | link:#fmt-range_format_kind[`range_format_kind`] | | link:#fmt-range_formatter-00[`range_formatter`] | | link:#fmt-range_formatter-07[`range_formatter<T, Char>`] | | link:#fmt-rgb[`rgb`] | | link:#fmt-runtime_format_string[`runtime_format_string`] | | link:#fmt-static_format_result[`static_format_result`] | | link:#fmt-string_buffer[`string_buffer`] | | link:#fmt-text_style[`text_style`] | A text style consisting of foreground and background colors and emphasis. | link:#fmt-tuple_join_view[`tuple_join_view`] | | link:#fmt-vprintf_args[`vprintf_args`] | | link:#fmt-weekday[`weekday`] | | link:#fmt-writer[`writer`] | | link:#fmt-year[`year`] | | link:#fmt-year_month_day[`year_month_day`] | | link:#fmt-appender[`appender`] | | link:#fmt-basic_format_context[`basic_format_context`] | | link:#fmt-basic_format_parse_context[`basic_format_parse_context`] | | link:#fmt-basic_format_string[`basic_format_string`] | | link:#fmt-bool_constant[`bool_constant`] | | link:#fmt-buffered_context[`buffered_context`] | | link:#fmt-conditional_t[`conditional_t`] | | link:#fmt-cstring_view[`cstring_view`] | | link:#fmt-decay_t[`decay_t`] | | link:#fmt-enable_if_t[`enable_if_t`] | | link:#fmt-format_args[`format_args`] | | link:#fmt-format_context[`format_context`] | | link:#fmt-format_parse_context[`format_parse_context`] | | link:#fmt-format_string[`format_string`] | | link:#fmt-is_formattable[`is_formattable`] | | link:#fmt-local_time[`local_time`] | | link:#fmt-make_unsigned_t[`make_unsigned_t`] | | link:#fmt-memory_buffer[`memory_buffer`] | | link:#fmt-nullptr_t[`nullptr_t`] | | link:#fmt-ostream_formatter[`ostream_formatter`] | | link:#fmt-printf_args[`printf_args`] | | link:#fmt-printf_context[`printf_context`] | | link:#fmt-remove_const_t[`remove_const_t`] | | link:#fmt-remove_cvref_t[`remove_cvref_t`] | | link:#fmt-remove_reference_t[`remove_reference_t`] | | link:#fmt-string_view[`string_view`] | | link:#fmt-sys_time[`sys_time`] | | link:#fmt-underlying_t[`underlying_t`] | | link:#fmt-utc_time[`utc_time`] | | link:#fmt-vargs[`vargs`] | | link:#fmt-void_t[`void_t`] | | link:#fmt-wcstring_view[`wcstring_view`] | | link:#fmt-wformat_args[`wformat_args`] | | link:#fmt-wformat_context[`wformat_context`] | | link:#fmt-wformat_parse_context[`wformat_parse_context`] | | link:#fmt-wformat_string[`wformat_string`] | | link:#fmt-wmemory_buffer[`wmemory_buffer`] | | link:#fmt-wprintf_args[`wprintf_args`] | | link:#fmt-wprintf_context[`wprintf_context`] | | link:#fmt-wstring_view[`wstring_view`] | |=== == Enums [cols=1] |=== | Name | link:#fmt-_04enum[`Unnamed enum`] | link:#fmt-align[`align`] | link:#fmt-arg_id_kind[`arg_id_kind`] | link:#fmt-color[`color`] | link:#fmt-emphasis[`emphasis`] | link:#fmt-presentation_type[`presentation_type`] | link:#fmt-range_format[`range_format`] | link:#fmt-sign[`sign`] | link:#fmt-terminal_color[`terminal_color`] |=== == Functions [cols=2] |=== | Name | Description | link:#fmt-2function-0a[`Unnamed overloads`] | | link:#fmt-arg[`arg`] | Returns a named argument to be used in a formatting function. It should only be used in a call to a formatting function. | link:#fmt-assert_fail[`assert_fail`] | | link:#fmt-bg[`bg`] | Creates a text style from the background color. | link:#fmt-fg[`fg`] | Creates a text style from the foreground (text) color. | link:#fmt-format-02[`format`] | `format` overloads | link:#fmt-format_system_error[`format_system_error`] | Formats an error message for an error returned by an operating system or a language runtime, for example a file opening error, and writes it to `out`. The format is the same as the one used by `std::system_error(ec, message)` where `ec` is `std::error_code(error_code, std::generic_category())`. It is implementation‐defined but normally looks like: | link:#fmt-format_to-0da[`format_to`] | `format_to` overloads | link:#fmt-format_to_n-0b[`format_to_n`] | Formats `args` according to specifications in `fmt`, writes up to `n` characters of the result to the output iterator `out` and returns the total (not truncated) output size and the iterator past the end of the output range. `format_to_n` does not append a terminating null character. | link:#fmt-formatted_size-0e2[`formatted_size`] | Returns the number of chars in the output of `format(fmt, args...)`. | link:#fmt-fprintf-0b2[`fprintf`] | Formats `args` according to specifications in `fmt` and writes the output to `f`. | link:#fmt-gmtime-03[`gmtime`] | Converts given time since epoch as `std::time_t` value into calendar time, expressed in Coordinated Universal Time (UTC). Unlike `std::gmtime`, this function is thread‐safe on most platforms. | link:#fmt-group_digits[`group_digits`] | Returns a view that formats an integer value using ',' as a locale‐independent thousands separator. | link:#fmt-join-038[`join`] | `join` overloads | link:#fmt-make_format_args[`make_format_args`] | | link:#fmt-make_printf_args[`make_printf_args`] | Constructs an `format_arg_store` object that contains references to arguments and can be implicitly converted to `printf_args`. | link:#fmt-make_wformat_args[`make_wformat_args`] | | link:#fmt-max_of[`max_of`] | | link:#fmt-min_of[`min_of`] | | link:#fmt-operator_bitor-08[`operator|`] | Bitwise disjunction operators | link:#fmt-print-02[`print`] | `print` overloads | link:#fmt-printf[`printf`] | Formats `args` according to specifications in `fmt` and writes the output to `stdout`. | link:#fmt-println-0d[`println`] | `println` overloads | link:#fmt-ptr-06[`ptr`] | Converts `p` to `const void*` for pointer formatting. | link:#fmt-report_error[`report_error`] | Reports a format error at compile time or, via a `format_error` exception, at runtime. | link:#fmt-report_system_error[`report_system_error`] | | link:#fmt-runtime-0c[`runtime`] | Creates a runtime format string. | link:#fmt-sprintf-05[`sprintf`] | Formats `args` according to specifications in `fmt` and returns the result as as string. | link:#fmt-streamed[`streamed`] | Returns a view that formats `value` via an ostream `operator<<`. | link:#fmt-styled[`styled`] | Returns an argument that will be formatted using ANSI escape sequences, to be used in a formatting function. | link:#fmt-system_category[`system_category`] | | link:#fmt-system_error[`system_error`] | Constructs `std::system_error` with a message formatted with `fmt::format(fmt, args...)`. `error_code` is a system error code as given by `errno`. | link:#fmt-to_string-0bf[`to_string`] | Converts `value` to `std::string` using the default format for type `T`. | link:#fmt-to_wstring[`to_wstring`] | Converts `value` to `std::wstring` using the default format for type `T`. | link:#fmt-underlying[`underlying`] | Converts `e` to the underlying type. | link:#fmt-vformat-02[`vformat`] | | link:#fmt-vformat_to-0b[`vformat_to`] | `vformat_to` overloads | link:#fmt-vformat_to_n-01[`vformat_to_n`] | | link:#fmt-vfprintf[`vfprintf`] | | link:#fmt-vprint-007[`vprint`] | | link:#fmt-vprint_buffered[`vprint_buffered`] | | link:#fmt-vprintln[`vprintln`] | | link:#fmt-vsprintf[`vsprintf`] | | link:#fmt-vsystem_error[`vsystem_error`] | | link:#fmt-operator_eq[`operator==`] | Equality operator | link:#fmt-operator_not_eq[`operator!=`] | Inequality operator | link:#fmt-operator_lt[`operator<`] | Less‐than operator | link:#fmt-operator_le[`operator<=`] | Less‐than‐or‐equal operator | link:#fmt-operator_gt[`operator>`] | Greater‐than operator | link:#fmt-operator_ge[`operator>=`] | Greater‐than‐or‐equal operator |=== == Concepts [cols=1] |=== | Name | link:#fmt-formattable[`formattable`] |=== == Functions [cols=1] |=== | Name | link:#fmt-enums-format_as[`format_as`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Enum> constexpr link:#fmt-underlying_t[underlying_t<Enum>] format_as(Enum e) noexcept; ---- == Functions [cols=2] |=== | Name | Description | link:#fmt-safe_duration_cast-lossless_integral_conversion-02[`lossless_integral_conversion`] | Converts From to To, without loss. If the dynamic value of from can't be converted to To without loss, ec is set. | link:#fmt-safe_duration_cast-safe_duration_cast[`safe_duration_cast`] | Safe duration_cast between floating point durations | link:#fmt-safe_duration_cast-safe_float_conversion-05[`safe_float_conversion`] | converts From to To if possible, otherwise ec is set. |=== Converts From to To, without loss. If the dynamic value of from can't be converted to To without loss, ec is set. == Synopses Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To link:#fmt-safe_duration_cast-lossless_integral_conversion-08[lossless_integral_conversion]( From const from, int& ec); ---- [.small]#link:#fmt-safe_duration_cast-lossless_integral_conversion-08[_» more..._]# Converts From to To, without loss. If the dynamic value of from can't be converted to To without loss, ec is set. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To link:#fmt-safe_duration_cast-lossless_integral_conversion-06[lossless_integral_conversion]( From const from, int& ec); ---- [.small]#link:#fmt-safe_duration_cast-lossless_integral_conversion-06[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To link:#fmt-safe_duration_cast-lossless_integral_conversion-0e[lossless_integral_conversion]( From const from, int& ec); ---- [.small]#link:#fmt-safe_duration_cast-lossless_integral_conversion-0e[_» more..._]# == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To lossless_integral_conversion( From const from, int& ec); ---- Converts From to To, without loss. If the dynamic value of from can't be converted to To without loss, ec is set. == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To lossless_integral_conversion( From const from, int& ec); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To lossless_integral_conversion( From const from, int& ec); ---- Safe duration_cast between floating point durations == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename FromRep, typename FromPeriod> To safe_duration_cast( std::chrono::duration<FromRep, FromPeriod> from, int& ec); ---- converts From to To if possible, otherwise ec is set. == Synopses Declared in `<fmt/chrono.h>` converts From to To if possible, otherwise ec is set. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To link:#fmt-safe_duration_cast-safe_float_conversion-03[safe_float_conversion]( From const from, int& ec); ---- [.small]#link:#fmt-safe_duration_cast-safe_float_conversion-03[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To link:#fmt-safe_duration_cast-safe_float_conversion-09[safe_float_conversion]( From const from, int& ec); ---- [.small]#link:#fmt-safe_duration_cast-safe_float_conversion-09[_» more..._]# converts From to To if possible, otherwise ec is set. == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To safe_float_conversion( From const from, int& ec); ---- == Description input | output ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐|‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐ NaN | NaN Inf | Inf normal, fits in output | converted (possibly lossy) normal, does not fit in output | ec is set subnormal | best effort ‐Inf | ‐Inf == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename To, typename From> constexpr To safe_float_conversion( From const from, int& ec); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using appender = link:#fmt-basic_appender[basic_appender<char>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename Char> using basic_format_context = link:#fmt-conditional_t[conditional_t<std::is_same<OutputIt, appender>::value, context, generic_context<OutputIt, Char>>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> using basic_format_parse_context = link:#fmt-parse_context-0f[parse_context<Char>]; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, typename... T> using basic_format_string = link:#fmt-basic_fstring[basic_fstring<Char, T...>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<bool B> using bool_constant = std::integral_constant<bool, B>; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> using buffered_context = link:#fmt-conditional_t[conditional_t<std::is_same<Char, char>::value, context, generic_context<basic_appender<Char>, Char>>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< bool B, typename T, typename F> using conditional_t = std::conditional<B, T, F>::type; ---- == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using cstring_view = link:#fmt-basic_cstring_view[basic_cstring_view<char>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> using decay_t = std::decay<T>::type; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< bool B, typename T = void> using enable_if_t = T; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using format_args = link:#fmt-basic_format_args[basic_format_args<context>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using format_context = link:#fmt-context[context]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using format_parse_context = link:#fmt-parse_context-0f[parse_context<char>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> using format_string = fstring<T...>::t; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char = char> using is_formattable = link:#fmt-bool_constant[bool_constant<!std::is_same<detail::mapped_t<conditional_t<std::is_void<T>::value, int *, T>, Char>, void>::value>]; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<class Duration> using local_time = std::chrono::time_point</* implementation-defined */, Duration>; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> using make_unsigned_t = std::make_unsigned<T>::type; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using memory_buffer = link:#fmt-basic_memory_buffer[basic_memory_buffer<char>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using nullptr_t = decltype(nullptr); ---- == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using ostream_formatter = link:#fmt-basic_ostream_formatter[basic_ostream_formatter<char>]; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using printf_args = link:#fmt-basic_format_args[basic_format_args<printf_context>]; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using printf_context = link:#fmt-basic_printf_context[basic_printf_context<char>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> using remove_const_t = std::remove_const<T>::type; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> using remove_cvref_t = std::remove_cv<remove_reference_t<T>>::type; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> using remove_reference_t = std::remove_reference<T>::type; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using string_view = link:#fmt-basic_string_view[basic_string_view<char>]; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Duration> using sys_time = std::chrono::time_point<std::chrono::system_clock, Duration>; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> using underlying_t = std::underlying_type<T>::type; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Duration> using utc_time = std::chrono::time_point</* implementation-defined */, Duration>; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> using vargs = /* implementation-defined */; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename...> using void_t = void; ---- == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wcstring_view = link:#fmt-basic_cstring_view[basic_cstring_view<wchar_t>]; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wformat_args = link:#fmt-basic_format_args[basic_format_args<wformat_context>]; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wformat_context = link:#fmt-buffered_context[buffered_context<wchar_t>]; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wformat_parse_context = link:#fmt-parse_context-0f[parse_context<wchar_t>]; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> using wformat_string = basic_format_string<wchar_t, T...>::t; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wmemory_buffer = link:#fmt-basic_memory_buffer[basic_memory_buffer<wchar_t>]; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wprintf_args = link:#fmt-basic_format_args[basic_format_args<wprintf_context>]; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wprintf_context = link:#fmt-basic_printf_context[basic_printf_context<wchar_t>]; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using wstring_view = link:#fmt-basic_string_view[basic_string_view<wchar_t>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> class basic_appender; ---- == Types [cols=1] |=== | Name | link:#fmt-basic_appender-container_type[`container_type`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_appender-2constructor[`basic_appender`] [.small]#[constructor]# | Construct from `buffer` | link:#fmt-basic_appender-operator_assign[`operator=`] | Assignment operator | link:#fmt-basic_appender-operator_star[`operator*`] | Dereference operator | link:#fmt-basic_appender-operator_inc-0b[`operator++`] | Increment operators |=== == Protected Data Members [cols=1] |=== | Name | link:#fmt-basic_appender-container[`container`] |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using container_type = /* implementation-defined */; ---- Construct from `buffer` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_appender(/* implementation-defined */& buf); ---- == Parameters [cols=2] |=== | Name | Description | *buf* | The object to copy construct from |=== Assignment operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_appender[basic_appender]& operator=(T c); ---- == Return Value Reference to the current object == Parameters [cols=2] |=== | Name | Description | *c* | The object to assign from |=== Dereference operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_appender[basic_appender]& operator*(); ---- == Return Value Reference to the current object Increment operators == Synopses Declared in `<fmt/base.h>` Increment operator [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_appender[basic_appender]& link:#fmt-basic_appender-operator_inc-04[operator++](); ---- [.small]#link:#fmt-basic_appender-operator_inc-04[_» more..._]# Increment operator [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_appender[basic_appender] link:#fmt-basic_appender-operator_inc-0e[operator++](int); ---- [.small]#link:#fmt-basic_appender-operator_inc-0e[_» more..._]# Increment operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_appender[basic_appender]& operator++(); ---- == Return Value Reference to the current object Increment operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_appender[basic_appender] operator++(int); ---- == Return Value Another instance of the object == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- /* implementation-defined */* container; ---- A reference to a null‐terminated string. It can be constructed from a C string or `std::string`. == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> class basic_cstring_view; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_cstring_view-2constructor-0c[`basic_cstring_view`] [.small]#[constructor]# | Constructors | link:#fmt-basic_cstring_view-c_str[`c_str`] | Returns the pointer to a C string. |=== == Description You can use one of the following type aliases for common character types: +‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+ | Type | Definition | +_______=+_____________===+ | cstring_view | basic_cstring_view<char> | +‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+ | wcstring_view | basic_cstring_view<wchar_t> | +‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+ This class is most useful as a parameter type for functions that wrap C APIs. Constructors == Synopses Declared in `<fmt/os.h>` Constructs a string reference from an `std::string` object. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_cstring_view-2constructor-0f[basic_cstring_view](std::basic_string<Char> const& s); ---- [.small]#link:#fmt-basic_cstring_view-2constructor-0f[_» more..._]# Constructs a string reference object from a C string. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_cstring_view-2constructor-07[basic_cstring_view](Char const* s); ---- [.small]#link:#fmt-basic_cstring_view-2constructor-07[_» more..._]# Constructs a string reference from an `std::string` object. == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- basic_cstring_view(std::basic_string<Char> const& s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to copy construct from |=== Constructs a string reference object from a C string. == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- basic_cstring_view(Char const* s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to construct from |=== Returns the pointer to a C string. == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- Char const* c_str() const; ---- == Return Value the pointer to a C string. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> class basic_format_arg; ---- == Types [cols=1] |=== | Name | link:#fmt-basic_format_arg-handle[`handle`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_format_arg-2constructor-08[`basic_format_arg`] [.small]#[constructor]# | Constructors | link:#fmt-basic_format_arg-format_custom[`format_custom`] | | link:#fmt-basic_format_arg-type[`type`] | | link:#fmt-basic_format_arg-visit[`visit`] | Visits an argument dispatching to the appropriate visit method based on the argument type. For example, if the argument type is `double` then `vis(value)` will be called with the value of type `double`. | link:#fmt-basic_format_arg-2conversion[`operator bool`] | Conversion to `bool` |=== == Friends [cols=2] |=== | Name | Description | `link:#fmt-basic_format_args[fmt::basic_format_args]` | A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class handle; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_format_arg-handle-2constructor[`handle`] [.small]#[constructor]# | Construct from `custom_value` | link:#fmt-basic_format_arg-handle-format[`format`] | |=== Construct from `custom_value` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit handle(/* implementation-defined */ custom); ---- == Parameters [cols=2] |=== | Name | Description | *custom* | The object to construct from |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void format( link:#fmt-parse_context-0f[parse_context<char_type>]& parse_ctx, Context& ctx) const; ---- Constructors == Synopses Declared in `<fmt/base.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_arg-2constructor-00[basic_format_arg](); ---- [.small]#link:#fmt-basic_format_arg-2constructor-00[_» more..._]# Construct from `T` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-basic_format_arg-2constructor-02[basic_format_arg](T&& val); ---- [.small]#link:#fmt-basic_format_arg-2constructor-02[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_format_arg-2constructor-0e[basic_format_arg]( /* implementation-defined */ const* args, size_t size); ---- [.small]#link:#fmt-basic_format_arg-2constructor-0e[_» more..._]# Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_format_arg(); ---- Construct from `T` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> basic_format_arg(T&& val); ---- == Parameters [cols=2] |=== | Name | Description | *val* | The object to move construct from |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- basic_format_arg( /* implementation-defined */ const* args, size_t size); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool format_custom( link:#fmt-basic_format_arg[char_type] const* parse_begin, link:#fmt-parse_context-0f[parse_context<char_type>]& parse_ctx, Context& ctx); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- /* implementation-defined */ type() const; ---- Visits an argument dispatching to the appropriate visit method based on the argument type. For example, if the argument type is `double` then `vis(value)` will be called with the value of type `double`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Visitor> [[always_inline]] constexpr decltype(vis(0)) visit(Visitor&& vis) const; ---- Conversion to `bool` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit operator bool() const noexcept; ---- == Return Value The object converted to `bool` A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> class basic_format_args; ---- == Types [cols=1] |=== | Name | link:#fmt-basic_format_args-format_arg[`format_arg`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_format_args-2constructor-0d3[`basic_format_args`] [.small]#[constructor]# | Constructors | link:#fmt-basic_format_args-get-016[`get`] | Returns the argument with the specified id. | link:#fmt-basic_format_args-get_id[`get_id`] | | link:#fmt-basic_format_args-max_size[`max_size`] | |=== == Data Members [cols=1] |=== | Name | link:#fmt-basic_format_args-args_[`args_`] [.small]#[variant member]# | link:#fmt-basic_format_args-values_[`values_`] [.small]#[variant member]# |=== == Description void vlog(fmt::string_view fmt, fmt::format_args args); // OK fmt::format_args args = fmt::make_format_args(); // Dangling reference == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using format_arg = link:#fmt-basic_format_arg[basic_format_arg<Context>]; ---- Constructors == Synopses Declared in `<fmt/base.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_args-2constructor-05[basic_format_args](); ---- [.small]#link:#fmt-basic_format_args-2constructor-05[_» more..._]# Constructs a `basic_format_args` object from `format_arg_store`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< int NUM_ARGS, int NUM_NAMED_ARGS, unsigned long long DESC> [[always_inline]] constexpr link:#fmt-basic_format_args-2constructor-06[basic_format_args](link:#fmt-basic_format_args[store<NUM_ARGS, NUM_NAMED_ARGS, DESC>] const& s); ---- [.small]#link:#fmt-basic_format_args-2constructor-06[_» more..._]# Construct from `store` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< int NUM_ARGS, int NUM_NAMED_ARGS, unsigned long long DESC> constexpr link:#fmt-basic_format_args-2constructor-00[basic_format_args](link:#fmt-basic_format_args[store<NUM_ARGS, NUM_NAMED_ARGS, DESC>] const& s); ---- [.small]#link:#fmt-basic_format_args-2constructor-00[_» more..._]# Constructs a `basic_format_args` object from a dynamic list of arguments. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_args-2constructor-0de[basic_format_args]( link:#fmt-basic_format_args-format_arg[format_arg] const* args, int count, bool has_named = false); ---- [.small]#link:#fmt-basic_format_args-2constructor-0de[_» more..._]# Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_format_args(); ---- Constructs a `basic_format_args` object from `format_arg_store`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< int NUM_ARGS, int NUM_NAMED_ARGS, unsigned long long DESC> [[always_inline]] constexpr basic_format_args(link:#fmt-basic_format_args[store<NUM_ARGS, NUM_NAMED_ARGS, DESC>] const& s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to copy construct from |=== Construct from `store` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< int NUM_ARGS, int NUM_NAMED_ARGS, unsigned long long DESC> constexpr basic_format_args(link:#fmt-basic_format_args[store<NUM_ARGS, NUM_NAMED_ARGS, DESC>] const& s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to copy construct from |=== Constructs a `basic_format_args` object from a dynamic list of arguments. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_format_args( link:#fmt-basic_format_args-format_arg[format_arg] const* args, int count, bool has_named = false); ---- == Parameters [cols=2] |=== | Name | Description | *args* | The object to construct from |=== Returns the argument with the specified id. == Synopses Declared in `<fmt/base.h>` Returns the argument with the specified id. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_args-format_arg[format_arg] link:#fmt-basic_format_args-get-0a[get](int id) const; ---- [.small]#link:#fmt-basic_format_args-get-0a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> link:#fmt-basic_format_args-format_arg[format_arg] link:#fmt-basic_format_args-get-010[get](link:#fmt-basic_string_view[basic_string_view<Char>] name) const; ---- [.small]#link:#fmt-basic_format_args-get-010[_» more..._]# Returns the argument with the specified id. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_args-format_arg[format_arg] get(int id) const; ---- == Return Value the argument with the specified id. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> link:#fmt-basic_format_args-format_arg[format_arg] get(link:#fmt-basic_string_view[basic_string_view<Char>] name) const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr int get_id(link:#fmt-basic_string_view[basic_string_view<Char>] name) const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- int max_size() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_format_arg[basic_format_arg<Context>] const* args_; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- /* implementation-defined */ const* values_; ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, typename... T> struct basic_fstring; ---- == Types [cols=1] |=== | Name | link:#fmt-basic_fstring-t[`t`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_fstring-2constructor-0e[`basic_fstring`] [.small]#[constructor]# | Constructors | link:#fmt-basic_fstring-get[`get`] | | link:#fmt-basic_fstring-2conversion[`operator basic_string_view<Char>`] | Conversion to `basic_string_view` |=== == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using t = link:#fmt-basic_fstring[basic_fstring]; ---- Constructors == Synopses Declared in `<fmt/xchar.h>` Construct from `runtime_format_string` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_fstring-2constructor-09f[basic_fstring](link:#fmt-runtime_format_string[runtime_format_string<Char>] fmt); ---- [.small]#link:#fmt-basic_fstring-2constructor-09f[_» more..._]# Construct from `S` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] link:#fmt-basic_fstring-2constructor-0c[basic_fstring](S const& value); ---- [.small]#link:#fmt-basic_fstring-2constructor-0c[_» more..._]# Construct from `S` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] consteval link:#fmt-basic_fstring-2constructor-099[basic_fstring](S const& s); ---- [.small]#link:#fmt-basic_fstring-2constructor-099[_» more..._]# Construct from `runtime_format_string` == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- basic_fstring(link:#fmt-runtime_format_string[runtime_format_string<Char>] fmt); ---- == Parameters [cols=2] |=== | Name | Description | *fmt* | The object to construct from |=== Construct from `S` == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] basic_fstring(S const& value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The object to copy construct from |=== Construct from `S` == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] consteval basic_fstring(S const& s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to copy construct from |=== == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_string_view[basic_string_view<Char>] get() const; ---- Conversion to `basic_string_view` == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- operator link:#fmt-basic_string_view[basic_string_view<Char>]() const; ---- == Return Value An implementation of `std::basic_string_view` for pre‐C++17. It provides a subset of the API. `fmt::basic_string_view` is used for format strings even if `std::basic_string_view` is available to prevent issues when a library is compiled with a different `‐std` option than the client code (which is not recommended). A dynamically growing memory buffer for trivially copyable/constructible types with the first `SIZE` elements stored in the object itself. Most commonly used via the `memory_buffer` alias for `char`. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, size_t SIZE = inline_buffer_size, typename Allocator = /* implementation-defined */> class basic_memory_buffer : public /* implementation-defined */ ---- == Base Classes [cols=2] |=== | Name | Description | `/* implementation-defined */` | A contiguous memory buffer with an optional growing ability. It is an internal class and shouldn't be used directly, only via `memory_buffer`. |=== == Types [cols=1] |=== | Name | link:#fmt-basic_memory_buffer-const_reference[`const_reference`] | link:#fmt-basic_memory_buffer-value_type[`value_type`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_memory_buffer-2constructor-0c[`basic_memory_buffer`] [.small]#[constructor]# | Constructs a `basic_memory_buffer` object moving the content of the other object to it. | link:#fmt-basic_memory_buffer-2destructor[`~basic_memory_buffer`] [.small]#[destructor]# | Destructor | link:#fmt-basic_memory_buffer-operator_assign[`operator=`] | Moves the content of the other `basic_memory_buffer` object to this one. | link:#fmt-basic_memory_buffer-append[`append`] | | link:#fmt-basic_memory_buffer-get_allocator[`get_allocator`] | | link:#fmt-basic_memory_buffer-reserve[`reserve`] | Increases the buffer capacity to `new_capacity`. | link:#fmt-basic_memory_buffer-resize[`resize`] | Resizes the buffer to contain `count` elements. If T is a POD type new elements may not be initialized. |=== == Description *Example*: auto out = fmt::memory_buffer(); fmt::format_to(std::back_inserter(out), "The answer is {}.", 42); This will append "The answer is 42." to `out`. The buffer content can be converted to `std::string` with `to_string(out)`. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using const_reference = T const&; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using value_type = T; ---- Constructs a `basic_memory_buffer` object moving the content of the other object to it. == Synopses Declared in `<fmt/format.h>` Constructs a `basic_memory_buffer` object moving the content of the other object to it. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_memory_buffer-2constructor-0d1[basic_memory_buffer](link:#fmt-basic_memory_buffer[basic_memory_buffer]&& other) noexcept; ---- [.small]#link:#fmt-basic_memory_buffer-2constructor-0d1[_» more..._]# Construct from `Allocator` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-basic_memory_buffer-2constructor-0da[basic_memory_buffer](Allocator const& alloc = Allocator()); ---- [.small]#link:#fmt-basic_memory_buffer-2constructor-0da[_» more..._]# Constructs a `basic_memory_buffer` object moving the content of the other object to it. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_memory_buffer(link:#fmt-basic_memory_buffer[basic_memory_buffer]&& other) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to move construct from |=== Construct from `Allocator` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit basic_memory_buffer(Allocator const& alloc = Allocator()); ---- == Parameters [cols=2] |=== | Name | Description | *alloc* | The object to copy construct from |=== Destructor == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr ~basic_memory_buffer(); ---- Moves the content of the other `basic_memory_buffer` object to this one. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_memory_buffer[basic_memory_buffer]& operator=(link:#fmt-basic_memory_buffer[basic_memory_buffer]&& other) noexcept; ---- == Return Value Reference to the current object == Parameters [cols=2] |=== | Name | Description | *other* | The object to move assign from |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename ContiguousRange> constexpr void append(ContiguousRange const& range); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- Allocator get_allocator() const; ---- Increases the buffer capacity to `new_capacity`. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void reserve(size_t new_capacity); ---- Resizes the buffer to contain `count` elements. If T is a POD type new elements may not be initialized. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void resize(size_t count); ---- == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct basic_ostream_formatter : link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-basic_ostream_formatter-format[`format`] | link:#fmt-basic_ostream_formatter-set_debug_format[`set_debug_format`] [.small]#[deleted]# |=== == Derived Classes [cols=2] |=== | Name | Description | link:#fmt-formatter-026[`formatter`] | | link:#fmt-formatter-09c7[`formatter`] | |=== == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Context> decltype(ctx.out()) format( T const& value, Context& ctx) const; ---- == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void set_debug_format() = delete; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> class basic_printf_context; ---- == Types [cols=1] |=== | Name | link:#fmt-basic_printf_context-char_type[`char_type`] |=== == Enums [cols=1] |=== | Name | link:#fmt-basic_printf_context-_04enum[`Unnamed enum`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_printf_context-2constructor[`basic_printf_context`] [.small]#[constructor]# | Constructs a `printf_context` object. References to the arguments are stored in the context object so make sure they have appropriate lifetimes. | link:#fmt-basic_printf_context-advance_to[`advance_to`] | | link:#fmt-basic_printf_context-arg[`arg`] | | link:#fmt-basic_printf_context-locale[`locale`] | | link:#fmt-basic_printf_context-out[`out`] | |=== == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using char_type = Char; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum Unnamed enum; ---- == Members [cols=1] |=== | Name | `builtin_types` |=== Constructs a `printf_context` object. References to the arguments are stored in the context object so make sure they have appropriate lifetimes. == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- basic_printf_context( link:#fmt-basic_appender[basic_appender<Char>] out, link:#fmt-basic_format_args[basic_format_args<basic_printf_context>] args); ---- == Parameters [cols=2] |=== | Name | Description | *out* | The object to construct from | *args* | A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: |=== == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void advance_to(link:#fmt-basic_appender[basic_appender<Char>]); ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_format_arg[basic_format_arg<basic_printf_context>] arg(int id) const; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-locale_ref[locale_ref] locale(); ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_appender[basic_appender<Char>] out(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class basic_specs; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-basic_specs-align[`align`] | link:#fmt-basic_specs-alt[`alt`] | link:#fmt-basic_specs-clear_alt[`clear_alt`] | link:#fmt-basic_specs-copy_fill_from[`copy_fill_from`] | link:#fmt-basic_specs-dynamic[`dynamic`] | link:#fmt-basic_specs-dynamic_precision[`dynamic_precision`] | link:#fmt-basic_specs-dynamic_width[`dynamic_width`] | link:#fmt-basic_specs-fill-07fc[`fill`] | link:#fmt-basic_specs-fill_size[`fill_size`] | link:#fmt-basic_specs-fill_unit[`fill_unit`] | link:#fmt-basic_specs-localized[`localized`] | link:#fmt-basic_specs-set_align[`set_align`] | link:#fmt-basic_specs-set_alt[`set_alt`] | link:#fmt-basic_specs-set_dynamic_precision[`set_dynamic_precision`] | link:#fmt-basic_specs-set_dynamic_width[`set_dynamic_width`] | link:#fmt-basic_specs-set_fill-05[`set_fill`] | link:#fmt-basic_specs-set_localized[`set_localized`] | link:#fmt-basic_specs-set_sign[`set_sign`] | link:#fmt-basic_specs-set_type[`set_type`] | link:#fmt-basic_specs-set_upper[`set_upper`] | link:#fmt-basic_specs-sign[`sign`] | link:#fmt-basic_specs-type[`type`] | link:#fmt-basic_specs-upper[`upper`] |=== == Derived Classes [cols=2] |=== | Name | Description | link:#fmt-format_specs[`format_specs`] | |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-align[align] align() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool alt() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void clear_alt(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void copy_fill_from(link:#fmt-basic_specs[basic_specs] const& specs); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool dynamic() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-arg_id_kind[arg_id_kind] dynamic_precision() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-arg_id_kind[arg_id_kind] dynamic_width() const; ---- == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr Char const* link:#fmt-basic_specs-fill-07fa[fill]() const; ---- [.small]#link:#fmt-basic_specs-fill-07fa[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr Char const* link:#fmt-basic_specs-fill-03[fill]() const; ---- [.small]#link:#fmt-basic_specs-fill-03[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr Char const* fill() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr Char const* fill() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr size_t fill_size() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr Char fill_unit() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool localized() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_align(link:#fmt-align[fmt::align] a); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_alt(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_dynamic_precision(link:#fmt-arg_id_kind[arg_id_kind] p); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_dynamic_width(link:#fmt-arg_id_kind[arg_id_kind] w); ---- == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void link:#fmt-basic_specs-set_fill-00[set_fill](char c); ---- [.small]#link:#fmt-basic_specs-set_fill-00[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr void link:#fmt-basic_specs-set_fill-0d[set_fill](link:#fmt-basic_string_view[basic_string_view<Char>] s); ---- [.small]#link:#fmt-basic_specs-set_fill-0d[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_fill(char c); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> constexpr void set_fill(link:#fmt-basic_string_view[basic_string_view<Char>] s); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_localized(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_sign(link:#fmt-sign[fmt::sign] s); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_type(link:#fmt-presentation_type[presentation_type] t); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_upper(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-sign[sign] sign() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-presentation_type[presentation_type] type() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool upper() const; ---- An implementation of `std::basic_string_view` for pre‐C++17. It provides a subset of the API. `fmt::basic_string_view` is used for format strings even if `std::basic_string_view` is available to prevent issues when a library is compiled with a different `‐std` option than the client code (which is not recommended). == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> class basic_string_view; ---- == Types [cols=1] |=== | Name | link:#fmt-basic_string_view-iterator[`iterator`] | link:#fmt-basic_string_view-value_type[`value_type`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-basic_string_view-2constructor-09[`basic_string_view`] [.small]#[constructor]# | Constructors | link:#fmt-basic_string_view-begin[`begin`] | | link:#fmt-basic_string_view-compare[`compare`] | | link:#fmt-basic_string_view-data[`data`] | Returns a pointer to the string data. | link:#fmt-basic_string_view-end[`end`] | | link:#fmt-basic_string_view-operator_subs[`operator[]`] | | link:#fmt-basic_string_view-remove_prefix[`remove_prefix`] | | link:#fmt-basic_string_view-size[`size`] | Returns the string size. | link:#fmt-basic_string_view-starts_with-0b[`starts_with`] | |=== == Friends [cols=2] |=== | Name | Description | `link:#fmt-operator_ge[fmt::operator>=]` | Greater‐than‐or‐equal operator | `link:#fmt-operator_gt[fmt::operator>]` | Greater‐than operator | `link:#fmt-operator_le[fmt::operator<=]` | Less‐than‐or‐equal operator | `link:#fmt-operator_lt[fmt::operator<]` | Less‐than operator | `link:#fmt-operator_not_eq[fmt::operator!=]` | Inequality operator | `link:#fmt-operator_eq[fmt::operator==]` | Equality operator |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using iterator = Char const*; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using value_type = Char; ---- Constructors == Synopses Declared in `<fmt/base.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_string_view-2constructor-07[basic_string_view]() noexcept; ---- [.small]#link:#fmt-basic_string_view-2constructor-07[_» more..._]# Construct from `nullptr_t` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_string_view-2constructor-0a0[basic_string_view](link:#fmt-nullptr_t[nullptr_t] value) = delete; ---- [.small]#link:#fmt-basic_string_view-2constructor-0a0[_» more..._]# Construct from `Char` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_string_view-2constructor-0a2[basic_string_view](Char const* s); ---- [.small]#link:#fmt-basic_string_view-2constructor-0a2[_» more..._]# Constructs a string view from a `std::basic_string` or a `std::basic_string_view` object. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> constexpr link:#fmt-basic_string_view-2constructor-06[basic_string_view](S const& s) noexcept; ---- [.small]#link:#fmt-basic_string_view-2constructor-06[_» more..._]# Constructs a string view object from a C string and a size. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_string_view-2constructor-08[basic_string_view]( Char const* s, size_t count) noexcept; ---- [.small]#link:#fmt-basic_string_view-2constructor-08[_» more..._]# Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_string_view() noexcept; ---- Construct from `nullptr_t` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_string_view(link:#fmt-nullptr_t[nullptr_t] value) = delete; ---- == Parameters [cols=2] |=== | Name | Description | *value* | The object to construct from |=== Construct from `Char` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_string_view(Char const* s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to construct from |=== Constructs a string view from a `std::basic_string` or a `std::basic_string_view` object. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> constexpr basic_string_view(S const& s) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to copy construct from |=== Constructs a string view object from a C string and a size. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr basic_string_view( Char const* s, size_t count) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to construct from |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_string_view-iterator[iterator] begin() const noexcept; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr int compare(link:#fmt-basic_string_view[basic_string_view] other) const; ---- Returns a pointer to the string data. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* data() const noexcept; ---- == Return Value a pointer to the string data. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_string_view-iterator[iterator] end() const noexcept; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const& operator[](size_t pos) const noexcept; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void remove_prefix(size_t n) noexcept; ---- Returns the string size. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr size_t size() const noexcept; ---- == Return Value the string size. == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool link:#fmt-basic_string_view-starts_with-08[starts_with](Char c) const noexcept; ---- [.small]#link:#fmt-basic_string_view-starts_with-08[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool link:#fmt-basic_string_view-starts_with-0a[starts_with](link:#fmt-basic_string_view[basic_string_view<Char>] sv) const noexcept; ---- [.small]#link:#fmt-basic_string_view-starts_with-0a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool link:#fmt-basic_string_view-starts_with-09[starts_with](Char const* s) const; ---- [.small]#link:#fmt-basic_string_view-starts_with-09[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool starts_with(Char c) const noexcept; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool starts_with(link:#fmt-basic_string_view[basic_string_view<Char>] sv) const noexcept; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool starts_with(Char const* s) const; ---- == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class buffered_file; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-buffered_file-2constructor-04[`buffered_file`] [.small]#[constructor]# | Constructors | link:#fmt-buffered_file-2destructor[`~buffered_file`] [.small]#[destructor]# | Destructor | link:#fmt-buffered_file-operator_assign-00[`operator=`] [.small]#[deleted]# | Assignment operators | link:#fmt-buffered_file-close[`close`] | | link:#fmt-buffered_file-descriptor[`descriptor`] | | link:#fmt-buffered_file-get[`get`] | | link:#fmt-buffered_file-print[`print`] | |=== == Friends [cols=2] |=== | Name | Description | `link:#fmt-file[fmt::file]` | |=== Constructors == Synopses Declared in `<fmt/os.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-buffered_file-2constructor-0e7[buffered_file]() noexcept; ---- [.small]#link:#fmt-buffered_file-2constructor-0e7[_» more..._]# Copy constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-buffered_file-2constructor-0e4[buffered_file](link:#fmt-buffered_file[buffered_file] const& other) = delete; ---- [.small]#link:#fmt-buffered_file-2constructor-0e4[_» more..._]# Move constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-buffered_file-2constructor-0d[buffered_file](link:#fmt-buffered_file[buffered_file]&& other) noexcept; ---- [.small]#link:#fmt-buffered_file-2constructor-0d[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-buffered_file-2constructor-06[buffered_file]( link:#fmt-cstring_view[cstring_view] filename, link:#fmt-cstring_view[cstring_view] mode); ---- [.small]#link:#fmt-buffered_file-2constructor-06[_» more..._]# Default constructor == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- buffered_file() noexcept; ---- Copy constructor == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- buffered_file(link:#fmt-buffered_file[buffered_file] const& other) = delete; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to copy construct from |=== Move constructor == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- buffered_file(link:#fmt-buffered_file[buffered_file]&& other) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to move construct from |=== == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- buffered_file( link:#fmt-cstring_view[cstring_view] filename, link:#fmt-cstring_view[cstring_view] mode); ---- Destructor == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- ~buffered_file() noexcept; ---- Assignment operators == Synopses Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-buffered_file-operator_assign-08[operator=](link:#fmt-buffered_file[buffered_file] const& other) = delete; ---- [.small]#link:#fmt-buffered_file-operator_assign-08[_» more..._]# Move assignment operator [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-buffered_file[buffered_file]& link:#fmt-buffered_file-operator_assign-03[operator=](link:#fmt-buffered_file[buffered_file]&& other); ---- [.small]#link:#fmt-buffered_file-operator_assign-03[_» more..._]# == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void operator=(link:#fmt-buffered_file[buffered_file] const& other) = delete; ---- Move assignment operator == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-buffered_file[buffered_file]& operator=(link:#fmt-buffered_file[buffered_file]&& other); ---- == Return Value Reference to the current object == Parameters [cols=2] |=== | Name | Description | *other* | The object to move assign from |=== == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void close(); ---- == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- int descriptor() const; ---- == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- FILE* get() const noexcept; ---- == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( link:#fmt-string_view[string_view] fmt, T const...&... args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- struct bytes; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-bytes-2constructor[`bytes`] [.small]#[constructor]# | Construct from `string_view` |=== == Data Members [cols=1] |=== | Name | link:#fmt-bytes-data[`data`] |=== Construct from `string_view` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit bytes(link:#fmt-string_view[string_view] s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to construct from |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-string_view[string_view] data; ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class compiled_string; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename...> struct conjunction : std::true_type ---- == Base Classes [cols=2] |=== | Name | Description | `std::true_type` | |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename P> struct link:#fmt-conjunction-0d[conjunction]<P> : P ---- == Base Classes [cols=2] |=== | Name | Description | `P` | |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename P1, typename... Pn> struct link:#fmt-conjunction-0d[conjunction]<P1, Pn...> : link:#fmt-conditional_t[conditional_t<bool(P1::value), conjunction<Pn...>, P1>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-conditional_t[conditional_t<bool(P1::value), conjunction<Pn...>, P1>]` | |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class context; ---- == Types [cols=1] |=== | Name | link:#fmt-context-char_type[`char_type`] | link:#fmt-context-format_arg[`format_arg`] | link:#fmt-context-iterator[`iterator`] |=== == Enums [cols=1] |=== | Name | link:#fmt-context-_04enum[`Unnamed enum`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-context-2constructor-0c[`context`] [.small]#[constructor]# [.small]#[deleted]# | Constructs a `context` object. References to the arguments are stored in the object so make sure they have appropriate lifetimes. | link:#fmt-context-operator_assign[`operator=`] [.small]#[deleted]# | | link:#fmt-context-advance_to[`advance_to`] | | link:#fmt-context-arg-02[`arg`] | | link:#fmt-context-arg_id[`arg_id`] | | link:#fmt-context-args[`args`] | | link:#fmt-context-locale[`locale`] | | link:#fmt-context-out[`out`] | |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using char_type = char; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using format_arg = link:#fmt-basic_format_arg[basic_format_arg<context>]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using iterator = link:#fmt-appender[appender]; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum Unnamed enum; ---- == Members [cols=1] |=== | Name | `builtin_types` |=== Constructs a `context` object. References to the arguments are stored in the object so make sure they have appropriate lifetimes. == Synopses Declared in `<fmt/base.h>` Copy constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-context-2constructor-08[context](link:#fmt-context[context] const& other) = delete; ---- [.small]#link:#fmt-context-2constructor-08[_» more..._]# Move constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-context-2constructor-0a[context](link:#fmt-context[context]&& other) = default; ---- [.small]#link:#fmt-context-2constructor-0a[_» more..._]# Constructs a `context` object. References to the arguments are stored in the object so make sure they have appropriate lifetimes. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-context-2constructor-0f[context]( link:#fmt-context-iterator[iterator] out, link:#fmt-format_args[format_args] args, link:#fmt-locale_ref[locale_ref] loc = {}); ---- [.small]#link:#fmt-context-2constructor-0f[_» more..._]# Copy constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- context(link:#fmt-context[context] const& other) = delete; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to copy construct from |=== Move constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr context(link:#fmt-context[context]&& other) = default; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to move construct from |=== Constructs a `context` object. References to the arguments are stored in the object so make sure they have appropriate lifetimes. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr context( link:#fmt-context-iterator[iterator] out, link:#fmt-format_args[format_args] args, link:#fmt-locale_ref[locale_ref] loc = {}); ---- == Parameters [cols=2] |=== | Name | Description | *out* | The object to construct from |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void operator=(link:#fmt-context[context] const& other) = delete; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void advance_to(link:#fmt-context-iterator[iterator]); ---- == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-context-format_arg[format_arg] link:#fmt-context-arg-07[arg](link:#fmt-string_view[string_view] name) const; ---- [.small]#link:#fmt-context-arg-07[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-context-format_arg[format_arg] link:#fmt-context-arg-03[arg](int id) const; ---- [.small]#link:#fmt-context-arg-03[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-context-format_arg[format_arg] arg(link:#fmt-string_view[string_view] name) const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-context-format_arg[format_arg] arg(int id) const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr int arg_id(link:#fmt-string_view[string_view] name) const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-format_args[format_args] const& args() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-locale_ref[locale_ref] locale() const; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-context-iterator[iterator] out() const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class day; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-day-2constructor-00[`day`] [.small]#[constructor]# | Constructors | link:#fmt-day-2conversion[`operator unsigned int`] | Conversion to `unsigned int` |=== Constructors == Synopses Declared in `<fmt/chrono.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-day-2constructor-04b[day]() = default; ---- [.small]#link:#fmt-day-2constructor-04b[_» more..._]# Construct from `unsigned int` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-day-2constructor-048[day](unsigned int d) noexcept; ---- [.small]#link:#fmt-day-2constructor-048[_» more..._]# Default constructor == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr day() = default; ---- Construct from `unsigned int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit day(unsigned int d) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *d* | The value to construct from |=== Conversion to `unsigned int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit operator unsigned int() const noexcept; ---- == Return Value The object converted to `unsigned int` A dynamic list of formatting arguments with storage. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> class dynamic_format_arg_store; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-dynamic_format_arg_store-2constructor[`dynamic_format_arg_store`] [.small]#[constructor]# | Default constructor | link:#fmt-dynamic_format_arg_store-clear[`clear`] | Erase all elements from the store. | link:#fmt-dynamic_format_arg_store-push_back-05[`push_back`] | `push_back` overloads | link:#fmt-dynamic_format_arg_store-reserve[`reserve`] | Reserves space to store at least `new_cap` arguments including `new_cap_named` named arguments. | link:#fmt-dynamic_format_arg_store-size[`size`] | Returns the number of elements in the store. | link:#fmt-dynamic_format_arg_store-2conversion[`operator basic_format_args<Context>`] | Conversion to `basic_format_args` |=== == Friends [cols=2] |=== | Name | Description | `link:#fmt-basic_format_args[fmt::basic_format_args]` | A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: |=== == Description It can be implicitly converted into `fmt::basic_format_args` for passing into type‐erased formatting functions such as `fmt::vformat`. Default constructor == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr dynamic_format_arg_store() = default; ---- Erase all elements from the store. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void clear(); ---- `push_back` overloads == Synopses Declared in `<fmt/args.h>` Adds a reference to the argument into the dynamic store for later passing to a formatting function. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void link:#fmt-dynamic_format_arg_store-push_back-00[push_back](std::reference_wrapper<T> arg); ---- [.small]#link:#fmt-dynamic_format_arg_store-push_back-00[_» more..._]# Adds an argument into the dynamic store for later passing to a formatting function. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void link:#fmt-dynamic_format_arg_store-push_back-0b5[push_back](T const& arg); ---- [.small]#link:#fmt-dynamic_format_arg_store-push_back-0b5[_» more..._]# Adds named argument into the dynamic store for later passing to a formatting function. `std::reference_wrapper` is supported to avoid copying of the argument. The name is always copied into the store. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void link:#fmt-dynamic_format_arg_store-push_back-0bf[push_back](/* implementation-defined */ const& arg); ---- [.small]#link:#fmt-dynamic_format_arg_store-push_back-0bf[_» more..._]# Adds a reference to the argument into the dynamic store for later passing to a formatting function. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void push_back(std::reference_wrapper<T> arg); ---- == Description *Example*: fmt::dynamic_format_arg_store<fmt::format_context> store; char band[]= "Rolling Stones"; store.push_back(std::cref(band)); band[9]= 'c'; // Changing str affects the output. std::string result = fmt::vformat("{}", store); // result == "Rolling Scones" Adds an argument into the dynamic store for later passing to a formatting function. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void push_back(T const& arg); ---- == Description Note that custom types and string types (but not string views) are copied into the store dynamically allocating memory if necessary. *Example*: fmt::dynamic_format_arg_store<fmt::format_context> store; store.push_back(42); store.push_back("abc"); store.push_back(1.5f); std::string result = fmt::vformat("{} and {} and {}", store); Adds named argument into the dynamic store for later passing to a formatting function. `std::reference_wrapper` is supported to avoid copying of the argument. The name is always copied into the store. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void push_back(/* implementation-defined */ const& arg); ---- Reserves space to store at least `new_cap` arguments including `new_cap_named` named arguments. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void reserve( size_t new_cap, size_t new_cap_named); ---- Returns the number of elements in the store. == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- size_t size() const noexcept; ---- == Return Value the number of elements in the store. Conversion to `basic_format_args` == Synopsis Declared in `<fmt/args.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- operator link:#fmt-basic_format_args[basic_format_args<Context>]() const; ---- == Return Value A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type‐erased functions such as `vformat`: == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class file; ---- An error reported from a formatting function. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class format_error : public std::runtime_error ---- == Base Classes [cols=2] |=== | Name | Description | `std::runtime_error` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-format_error-operator_assign[`operator=`] | link:#fmt-format_error-what[`what`] [.small]#[virtual]# |=== == Using Declarations [cols=1] |=== | Name | link:#fmt-format_error-format_error[`format_error`] |=== == Synopsis Declared in `<stdexcept>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- runtime_error& operator=(runtime_error const& value) noexcept; ---- == Synopsis Declared in `<stdexcept>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- virtual char const* what() const noexcept override; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using std::runtime_error::format_error; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Locale> class format_facet : public Locale::facet ---- == Base Classes [cols=2] |=== | Name | Description | `Locale::facet` | |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-format_facet-0ca-2constructor-0c[`format_facet`] [.small]#[constructor]# | Construct from `Locale` | link:#fmt-format_facet-0ca-2constructor-0a[`format_facet`] [.small]#[constructor]# | | link:#fmt-format_facet-0ca-put[`put`] | |=== == Static Data Members [cols=1] |=== | Name | link:#fmt-format_facet-0ca-id[`id`] |=== == Protected Member Functions [cols=1] |=== | Name | link:#fmt-format_facet-0ca-do_put[`do_put`] [.small]#[virtual]# |=== Construct from `Locale` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit format_facet(Locale& loc); ---- == Parameters [cols=2] |=== | Name | Description | *loc* | The object to copy construct from |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit format_facet( link:#fmt-string_view[string_view] sep = "", std::string grouping = "\3", std::string decimal_point = "."); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool put( link:#fmt-appender[appender] out, link:#fmt-loc_value[loc_value] val, link:#fmt-format_specs[format_specs] const& specs) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- static Locale::id id; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- virtual bool do_put( link:#fmt-appender[appender] out, link:#fmt-loc_value[loc_value] val, link:#fmt-format_specs[format_specs] const& specs) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> class link:#fmt-format_facet-0ca[format_facet]<locale> : public locale::facet ---- == Base Classes [cols=2] |=== | Name | Description | `locale::facet` | |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-format_facet-0c5-2constructor-0b[`format_facet`] [.small]#[constructor]# | Constructors | link:#fmt-format_facet-0c5-put[`put`] | |=== == Static Data Members [cols=1] |=== | Name | link:#fmt-format_facet-0c5-id[`id`] |=== == Protected Member Functions [cols=1] |=== | Name | link:#fmt-format_facet-0c5-do_put[`do_put`] [.small]#[virtual]# |=== Constructors == Synopses Declared in `<fmt/format.h>` Construct from `locale` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit link:#fmt-format_facet-0c5-2constructor-06[format_facet](locale& loc); ---- [.small]#link:#fmt-format_facet-0c5-2constructor-06[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit link:#fmt-format_facet-0c5-2constructor-05[format_facet]( link:#fmt-string_view[string_view] sep = "", std::string grouping = "\3", std::string decimal_point = "."); ---- [.small]#link:#fmt-format_facet-0c5-2constructor-05[_» more..._]# Construct from `locale` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit format_facet(locale& loc); ---- == Parameters [cols=2] |=== | Name | Description | *loc* | The object to copy construct from |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit format_facet( link:#fmt-string_view[string_view] sep = "", std::string grouping = "\3", std::string decimal_point = "."); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool put( link:#fmt-appender[appender] out, link:#fmt-loc_value[loc_value] val, link:#fmt-format_specs[format_specs] const& specs) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- static locale::id id; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- virtual bool do_put( link:#fmt-appender[appender] out, link:#fmt-loc_value[loc_value] val, link:#fmt-format_specs[format_specs] const& specs) const; ---- A fast integer formatter. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class format_int; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-format_int-2constructor-055[`format_int`] [.small]#[constructor]# | Constructors | link:#fmt-format_int-c_str[`c_str`] | Returns a pointer to the output buffer content with terminating null character appended. | link:#fmt-format_int-data[`data`] | Returns a pointer to the output buffer content. No terminating null character is appended. | link:#fmt-format_int-size[`size`] | Returns the number of characters written to the output buffer. | link:#fmt-format_int-str[`str`] | Returns the content of the output buffer as an `std::string`. |=== Constructors == Synopses Declared in `<fmt/format.h>` Construct from `int` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-format_int-2constructor-096[format_int](int value); ---- [.small]#link:#fmt-format_int-2constructor-096[_» more..._]# Construct from `unsigned int` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-format_int-2constructor-0f[format_int](unsigned int value); ---- [.small]#link:#fmt-format_int-2constructor-0f[_» more..._]# Construct from `long` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-format_int-2constructor-05a[format_int](long value); ---- [.small]#link:#fmt-format_int-2constructor-05a[_» more..._]# Construct from `unsigned long` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-format_int-2constructor-09b[format_int](unsigned long value); ---- [.small]#link:#fmt-format_int-2constructor-09b[_» more..._]# Construct from `long long` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-format_int-2constructor-03[format_int](long long value); ---- [.small]#link:#fmt-format_int-2constructor-03[_» more..._]# Construct from `unsigned long long` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-format_int-2constructor-0d[format_int](unsigned long long value); ---- [.small]#link:#fmt-format_int-2constructor-0d[_» more..._]# Construct from `int` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit format_int(int value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The value to construct from |=== Construct from `unsigned int` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit format_int(unsigned int value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The value to construct from |=== Construct from `long` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit format_int(long value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The value to construct from |=== Construct from `unsigned long` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit format_int(unsigned long value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The value to construct from |=== Construct from `long long` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit format_int(long long value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The value to construct from |=== Construct from `unsigned long long` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit format_int(unsigned long long value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The value to construct from |=== Returns a pointer to the output buffer content with terminating null character appended. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* c_str() const; ---- Returns a pointer to the output buffer content. No terminating null character is appended. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* data() const; ---- Returns the number of characters written to the output buffer. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr size_t size() const; ---- == Return Value the number of characters written to the output buffer. Returns the content of the output buffer as an `std::string`. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string str() const; ---- == Return Value the content of the output buffer as an `std::string`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- struct format_specs : link:#fmt-basic_specs[basic_specs] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-basic_specs[basic_specs]` | |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-format_specs-2constructor[`format_specs`] [.small]#[constructor]# | Default constructor | link:#fmt-basic_specs-align[`align`] | | link:#fmt-basic_specs-alt[`alt`] | | link:#fmt-basic_specs-clear_alt[`clear_alt`] | | link:#fmt-basic_specs-copy_fill_from[`copy_fill_from`] | | link:#fmt-basic_specs-dynamic[`dynamic`] | | link:#fmt-basic_specs-dynamic_precision[`dynamic_precision`] | | link:#fmt-basic_specs-dynamic_width[`dynamic_width`] | | link:#fmt-basic_specs-fill-07fa[`fill`] | | link:#fmt-basic_specs-fill_size[`fill_size`] | | link:#fmt-basic_specs-fill_unit[`fill_unit`] | | link:#fmt-basic_specs-localized[`localized`] | | link:#fmt-basic_specs-set_align[`set_align`] | | link:#fmt-basic_specs-set_alt[`set_alt`] | | link:#fmt-basic_specs-set_dynamic_precision[`set_dynamic_precision`] | | link:#fmt-basic_specs-set_dynamic_width[`set_dynamic_width`] | | link:#fmt-basic_specs-set_fill-05[`set_fill`] | | link:#fmt-basic_specs-set_localized[`set_localized`] | | link:#fmt-basic_specs-set_sign[`set_sign`] | | link:#fmt-basic_specs-set_type[`set_type`] | | link:#fmt-basic_specs-set_upper[`set_upper`] | | link:#fmt-basic_specs-sign[`sign`] | | link:#fmt-basic_specs-type[`type`] | | link:#fmt-basic_specs-upper[`upper`] | |=== == Data Members [cols=1] |=== | Name | link:#fmt-format_specs-precision[`precision`] | link:#fmt-format_specs-width[`width`] |=== Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr format_specs(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- int precision; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- int width; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> struct format_to_n_result; ---- == Data Members [cols=2] |=== | Name | Description | link:#fmt-format_to_n_result-out[`out`] | Iterator past the end of the output range. | link:#fmt-format_to_n_result-size[`size`] | Total (not truncated) output size. |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-format_to_n-04[`format_to_n`] | Formats `args` according to specifications in `fmt`, writes up to `n` characters of the result to the output iterator `out` and returns the total (not truncated) output size and the iterator past the end of the output range. `format_to_n` does not append a terminating null character. |=== Iterator past the end of the output range. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- OutputIt out; ---- Total (not truncated) output size. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- size_t size; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- struct format_to_result; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-format_to_result-2conversion[`operator char*`] | Conversion to `char` |=== == Data Members [cols=2] |=== | Name | Description | link:#fmt-format_to_result-out[`out`] | Pointer to just after the last successful write in the array. | link:#fmt-format_to_result-truncated[`truncated`] | Specifies if the output was truncated. |=== Conversion to `char` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr operator char*() const; ---- == Return Value The object converted to `char` Pointer to just after the last successful write in the array. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- char* out; ---- Specifies if the output was truncated. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool truncated; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char = char, typename Enable = void> struct formatter; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-formatter-02b-2constructor[`formatter`] [.small]#[constructor]# [.small]#[deleted]# | Default constructor |=== == Derived Classes [cols=2] |=== | Name | Description | link:#fmt-basic_ostream_formatter[`basic_ostream_formatter`] | | link:#fmt-formatter-003[`formatter`] | | link:#fmt-formatter-00b[`formatter`] | | link:#fmt-formatter-01a[`formatter`] | | link:#fmt-formatter-022[`formatter`] | | link:#fmt-formatter-03a[`formatter`] | | link:#fmt-formatter-043[`formatter`] | | link:#fmt-formatter-0516e8[`formatter`] | | link:#fmt-formatter-0516e9[`formatter`] | | link:#fmt-formatter-08e[`formatter`] | | link:#fmt-formatter-093[`formatter`] | | link:#fmt-formatter-094[`formatter`] | | link:#fmt-formatter-095[`formatter`] | | link:#fmt-formatter-09c6[`formatter`] | | link:#fmt-formatter-0a2[`formatter`] | | link:#fmt-formatter-0a3[`formatter`] | | link:#fmt-formatter-0b0[`formatter`] | | link:#fmt-formatter-0b30[`formatter`] | | link:#fmt-formatter-0b3b[`formatter`] | | link:#fmt-formatter-0ce9[`formatter`] | | link:#fmt-formatter-0cee[`formatter`] | | link:#fmt-formatter-0cf[`formatter`] | | link:#fmt-formatter-0d6[`formatter`] | | link:#fmt-formatter-0ee[`formatter`] | |=== Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- formatter() = delete; ---- == Synopsis Declared in `<fmt/format‐inl.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> struct link:#fmt-formatter-02b[formatter]</* implementation-defined */>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-01c-format[`format`] | link:#fmt-formatter-01c-parse[`parse`] |=== == Synopsis Declared in `<fmt/format‐inl.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-context-iterator[format_context::iterator] format( /* implementation-defined */ const& n, link:#fmt-format_context[format_context]& ctx) const; ---- == Synopsis Declared in `<fmt/format‐inl.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-parse_context-00-iterator[format_parse_context::iterator] parse(link:#fmt-format_parse_context[format_parse_context]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> struct link:#fmt-formatter-02b[formatter]<link:#fmt-bytes[bytes]>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-012-format[`format`] | link:#fmt-formatter-012-parse[`parse`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-bytes[bytes] b, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* parse(link:#fmt-parse_context-0f[parse_context]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> struct link:#fmt-formatter-02b[formatter]<std::error_code>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-07-format[`format`] | link:#fmt-formatter-07-parse[`parse`] | link:#fmt-formatter-07-set_debug_format[`set_debug_format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype(ctx.out()) format( std::error_code const& ec, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* parse(link:#fmt-parse_context-0f[parse_context]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_debug_format(bool set = true); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> struct link:#fmt-formatter-02b[formatter]<std::source_location>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-050-format[`format`] | link:#fmt-formatter-050-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::source_location const& loc, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr auto parse(link:#fmt-parse_context-0f[parse_context]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> struct link:#fmt-formatter-02b[formatter]<std::type_info>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-09e-format[`format`] | link:#fmt-formatter-09e-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> decltype(ctx.out()) format( std::type_info const& ti, Context& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* parse(link:#fmt-parse_context-0f[parse_context]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> struct link:#fmt-formatter-02b[formatter]<link:#fmt-group_digits_view[group_digits_view<T>]> : link:#fmt-formatter-02b[formatter<T>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<T>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0ee-format[`format`] | link:#fmt-formatter-0ee-parse[`parse`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-group_digits_view[group_digits_view<T>] view, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* parse(link:#fmt-parse_context-0f[parse_context]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> requires std::is_base_of<std::exception, T>::value struct link:#fmt-formatter-02b[formatter]<T, char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0c4-format[`format`] | link:#fmt-formatter-0c4-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> decltype(ctx.out()) format( std::exception const& ex, Context& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr char const* parse(link:#fmt-parse_context-0f[parse_context]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<std::atomic_flag, Char> : link:#fmt-formatter-02b[formatter<bool, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<bool, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-03a-format[`format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::atomic_flag const& v, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<std::byte, Char> : link:#fmt-formatter-02b[formatter<unsigned int, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<unsigned int, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0cee-format[`format`] |=== == Static Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0cee-format_as[`format_as`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> decltype(ctx.out()) format( std::byte b, Context& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- static unsigned char format_as(std::byte b); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-day[day], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0a5-format[`format`] | link:#fmt-formatter-0a5-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-day[day] d, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]</* implementation-defined */, Char> : /* implementation-defined */ ---- == Base Classes [cols=2] |=== | Name | Description | `/* implementation-defined */` | |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<std::thread::id, Char> : link:#fmt-basic_ostream_formatter[basic_ostream_formatter<Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-basic_ostream_formatter[basic_ostream_formatter<Char>]` | |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<std::monostate, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0ef-format[`format`] | link:#fmt-formatter-0ef-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::monostate const&, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-month[month], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-009b-format[`format`] | link:#fmt-formatter-009b-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-month[month] m, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<std::nullptr_t, Char> : link:#fmt-formatter-02b[formatter<void const*, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<void const*, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-095-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( std::nullptr_t value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<std::filesystem::path, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-049-format[`format`] | link:#fmt-formatter-049-parse[`parse`] | link:#fmt-formatter-049-set_debug_format[`set_debug_format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> auto format( std::filesystem::path const& p, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr auto parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_debug_format(bool set = true); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<tm, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0626-format[`format`] | link:#fmt-formatter-0626-parse[`parse`] |=== == Protected Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0626-do_format[`do_format`] | link:#fmt-formatter-0626-do_parse[`do_parse`] | link:#fmt-formatter-0626-localized[`localized`] | link:#fmt-formatter-0626-set_localized[`set_localized`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( tm const& tm, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Duration, typename FormatContext> decltype(ctx.out()) do_format( tm const& tm, FormatContext& ctx, Duration const* subsecs) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* do_parse( link:#fmt-parse_context-0f[parse_context<Char>]& ctx, bool has_timezone); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool localized() const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_localized(); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-weekday[weekday], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-018e-format[`format`] | link:#fmt-formatter-018e-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-weekday[weekday] wd, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-year[year], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-02a-format[`format`] | link:#fmt-formatter-02a-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-year[year] y, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-year_month_day[year_month_day], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0c6-format[`format`] | link:#fmt-formatter-0c6-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-year_month_day[year_month_day] val, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]</* implementation-defined */, Char> : link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-022-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( /* implementation-defined */ value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<signed char, Char> : link:#fmt-formatter-02b[formatter<int, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<int, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-01a-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( signed char value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<unsigned char, Char> : link:#fmt-formatter-02b[formatter<unsigned int, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<unsigned int, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0a3-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( unsigned char value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<short, Char> : link:#fmt-formatter-02b[formatter<int, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<int, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0a2-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( short value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<unsigned short, Char> : link:#fmt-formatter-02b[formatter<unsigned int, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<unsigned int, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0cf-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( unsigned short value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<long, Char> : link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-09c6-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( long value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<unsigned long, Char> : link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-08e-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( unsigned long value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<Char*, Char> : link:#fmt-formatter-02b[formatter<Char const*, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<Char const*, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-00b-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( Char* value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct link:#fmt-formatter-02b[formatter]<void*, Char> : link:#fmt-formatter-02b[formatter<void const*, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<void const*, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0b30-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype() format( void* value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename BitRef, typename Char> requires detail::is_bit_reference_like<BitRef>::value struct link:#fmt-formatter-02b[formatter]<BitRef, Char> : link:#fmt-formatter-02b[formatter<bool, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<bool, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0b0-format[`format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype(ctx.out()) format( BitRef const& v, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename R, typename Char> requires conjunction< bool_constant< range_format_kind<R, Char>::value != range_format::disabled && range_format_kind<R, Char>::value != range_format::map && range_format_kind<R, Char>::value != range_format::string && range_format_kind<R, Char>::value != range_format::debug_string>, detail::is_formattable_delayed<R, Char>>::value struct link:#fmt-formatter-02b[formatter]<R, Char>; ---- == Types [cols=1] |=== | Name | link:#fmt-formatter-018b-nonlocking[`nonlocking`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-formatter-018b-2constructor[`formatter`] [.small]#[constructor]# | Default constructor | link:#fmt-formatter-018b-format[`format`] | | link:#fmt-formatter-018b-parse[`parse`] | |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using nonlocking = void; ---- Default constructor == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr formatter(); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( range_type& range, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename R, typename Char> requires conjunction< bool_constant<range_format_kind<R, Char>::value == range_format::map>, detail::is_formattable_delayed<R, Char>>::value struct link:#fmt-formatter-02b[formatter]<R, Char>; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-formatter-0097-2constructor[`formatter`] [.small]#[constructor]# | Default constructor | link:#fmt-formatter-0097-format[`format`] | | link:#fmt-formatter-0097-parse[`parse`] | |=== Default constructor == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr formatter(); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( map_type& map, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename R, typename Char> requires range_format_kind<R, Char>::value == range_format::string || range_format_kind<R, Char>::value == range_format::debug_string struct link:#fmt-formatter-02b[formatter]<R, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-032-format[`format`] | link:#fmt-formatter-032-parse[`parse`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( range_type& range, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> requires detail::type_constant<T, Char>::value != detail::type::custom_type struct link:#fmt-formatter-02b[formatter]<T, Char> : /* implementation-defined */ ---- == Base Classes [cols=2] |=== | Name | Description | `/* implementation-defined */` | |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> requires conjunction<detail::is_container_adaptor_like<T>, bool_constant<range_format_kind<T, Char>::value == range_format::disabled>>::value struct link:#fmt-formatter-02b[formatter]<T, Char> : link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>]` | |=== == Types [cols=1] |=== | Name | link:#fmt-formatter-003-all[`all`] |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-003-format[`format`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using all = /* implementation-defined */; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( T const& value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Tuple, typename Char> requires fmt::is_tuple_like<Tuple>::value && fmt::is_tuple_formattable<Tuple, Char>::value struct link:#fmt-formatter-02b[formatter]<Tuple, Char>; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-formatter-0d1-2constructor[`formatter`] [.small]#[constructor]# | Default constructor | link:#fmt-formatter-0d1-format[`format`] | | link:#fmt-formatter-0d1-parse[`parse`] | | link:#fmt-formatter-0d1-set_brackets[`set_brackets`] | | link:#fmt-formatter-0d1-set_separator[`set_separator`] | |=== Default constructor == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr formatter(); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( Tuple const& value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_brackets( link:#fmt-basic_string_view[basic_string_view<Char>] open, link:#fmt-basic_string_view[basic_string_view<Char>] close); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_separator(link:#fmt-basic_string_view[basic_string_view<Char>] sep); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Variant, typename Char> requires std::conjunction_v< is_variant_like<Variant>, detail::is_variant_formattable<Variant, Char>> struct link:#fmt-formatter-02b[formatter]<Variant, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-005-format[`format`] | link:#fmt-formatter-005-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( Variant const& value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> requires is_formattable<T, Char>::value struct link:#fmt-formatter-02b[formatter]<std::atomic<T>, Char> : link:#fmt-formatter-02b[formatter<T, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<T, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0d6-format[`format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::atomic<T> const& v, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< size_t N, typename Char> struct link:#fmt-formatter-02b[formatter]<std::bitset<N>, Char> : link:#fmt-nested_formatter[nested_formatter<basic_string_view<Char>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-nested_formatter[nested_formatter<basic_string_view<Char>, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0f-format[`format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::bitset<N> const& bs, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct link:#fmt-formatter-02b[formatter]<std::complex<T>, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0a8-format[`format`] | link:#fmt-formatter-0a8-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::complex<T> const& c, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Duration, typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-local_time[local_time<Duration>], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-084-format[`format`] | link:#fmt-formatter-084-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-local_time[local_time<Duration>] val, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-nested_view[nested_view<T, Char>], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-040-format[`format`] | link:#fmt-formatter-040-parse[`parse`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-nested_view[nested_view<T, Char>] view, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> requires is_formattable<T, Char>::value struct link:#fmt-formatter-02b[formatter]<std::optional<T>, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-09c3-format[`format`] | link:#fmt-formatter-09c3-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::optional<T> const& opt, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr auto parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> requires is_formattable<remove_cvref_t<T>, Char>::value && !detail::has_format_as<T>::value && !detail::has_format_as_member<T>::value struct link:#fmt-formatter-02b[formatter]<std::reference_wrapper<T>, Char> : link:#fmt-formatter-02b[formatter<remove_cvref_t<T>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<remove_cvref_t<T>, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0b3b-format[`format`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::reference_wrapper<T> ref, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct link:#fmt-formatter-02b[formatter]</* implementation-defined */, Char> : link:#fmt-basic_ostream_formatter[basic_ostream_formatter<Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-basic_ostream_formatter[basic_ostream_formatter<Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-09c7-format[`format`] |=== == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Context> decltype(ctx.out()) format( /* implementation-defined */ view, Context& ctx) const; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct link:#fmt-formatter-02b[formatter]</* implementation-defined */, Char> : link:#fmt-formatter-02b[formatter<T, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<T, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-094-format[`format`] |=== == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( /* implementation-defined */ const& arg, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, typename Duration> struct link:#fmt-formatter-02b[formatter]<link:#fmt-sys_time[sys_time<Duration>], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-09d-format[`format`] | link:#fmt-formatter-09d-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-sys_time[sys_time<Duration>] val, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Tuple, typename Char> requires is_tuple_like<Tuple>::value struct link:#fmt-formatter-02b[formatter]<link:#fmt-tuple_join_view[tuple_join_view<Tuple, Char>], Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-08f-format[`format`] | link:#fmt-formatter-08f-parse[`parse`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> FormatContext::iterator format( link:#fmt-tuple_join_view[tuple_join_view<Tuple, Char>] const& value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< int N, typename Char> struct link:#fmt-formatter-02b[formatter]</* implementation-defined */, Char> : link:#fmt-formatter-02b[formatter<long long, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<long long, Char>]` | |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Duration, typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-utc_time[utc_time<Duration>], Char> : link:#fmt-formatter-02b[formatter<sys_time<Duration>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<sys_time<Duration>, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0516e8-format[`format`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( link:#fmt-utc_time[utc_time<Duration>] val, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, size_t N> struct link:#fmt-formatter-02b[formatter]<Char[], Char> : link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>]` | |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, typename Traits, typename Allocator> class link:#fmt-formatter-02b[formatter]<std::basic_string<Char, Traits, Allocator>, Char> : public link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter<basic_string_view<Char>, Char>]` | |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Rep, typename Period, typename Char> struct link:#fmt-formatter-02b[formatter]<std::chrono::duration<Rep, Period>, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-03b-format[`format`] | link:#fmt-formatter-03b-parse[`parse`] |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::chrono::duration<Rep, Period> d, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename E, typename Char> requires (std::is_void<T>::value || is_formattable<T, Char>::value) && is_formattable<E, Char>::value struct link:#fmt-formatter-02b[formatter]<std::expected<T, E>, Char>; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-0bc-format[`format`] | link:#fmt-formatter-0bc-parse[`parse`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( std::expected<T, E> const& value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename It, typename Sentinel, typename Char> struct link:#fmt-formatter-02b[formatter]<link:#fmt-join_view[join_view<It, Sentinel, Char>], Char>; ---- == Types [cols=1] |=== | Name | link:#fmt-formatter-000-nonlocking[`nonlocking`] |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-000-format[`format`] | link:#fmt-formatter-000-parse[`parse`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using nonlocking = void; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> decltype(ctx.out()) format( view& value, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct link:#fmt-formatter-02b[formatter]<T, Char, link:#fmt-void_t[void_t</* implementation-defined */>]> : link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-formatter-02b[formatter</* implementation-defined */, Char>]` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-formatter-093-format[`format`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename FormatContext> constexpr decltype(ctx.out()) format( T const& value, FormatContext& ctx) const; ---- A compile‐time format string. Use `format_string` in the public API to prevent type deduction. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> struct fstring; ---- == Types [cols=1] |=== | Name | link:#fmt-fstring-t[`t`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-fstring-2constructor-03[`fstring`] [.small]#[constructor]# | Constructors | link:#fmt-fstring-get[`get`] | | link:#fmt-fstring-2conversion[`operator string_view const&`] | Conversion to `string_view` |=== == Data Members [cols=1] |=== | Name | link:#fmt-fstring-str[`str`] |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using t = link:#fmt-fstring[fstring]; ---- Constructors == Synopses Declared in `<fmt/base.h>` Construct from `runtime_format_string` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-fstring-2constructor-07[fstring](link:#fmt-runtime_format_string[runtime_format_string] fmt); ---- [.small]#link:#fmt-fstring-2constructor-07[_» more..._]# Construct from `S` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] link:#fmt-fstring-2constructor-05[fstring](S const& value); ---- [.small]#link:#fmt-fstring-2constructor-05[_» more..._]# Construct from `S` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] consteval link:#fmt-fstring-2constructor-01[fstring](S const& s); ---- [.small]#link:#fmt-fstring-2constructor-01[_» more..._]# Construct from `char` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t N> [[always_inline]] consteval link:#fmt-fstring-2constructor-06[fstring](char const(& s)[]); ---- [.small]#link:#fmt-fstring-2constructor-06[_» more..._]# Construct from `runtime_format_string` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- fstring(link:#fmt-runtime_format_string[runtime_format_string] fmt); ---- == Parameters [cols=2] |=== | Name | Description | *fmt* | The object to construct from |=== Construct from `S` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] fstring(S const& value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The object to copy construct from |=== Construct from `S` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> [[always_inline]] consteval fstring(S const& s); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The object to copy construct from |=== Construct from `char` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t N> [[always_inline]] consteval fstring(char const(& s)[]); ---- == Parameters [cols=2] |=== | Name | Description | *s* | The value to construct from |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-string_view[string_view] get() const; ---- Conversion to `string_view` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- [[always_inline]] operator link:#fmt-string_view[string_view] const&() const; ---- == Return Value The object converted to `string_view` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-string_view[string_view] str; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename Char> class generic_context; ---- == Types [cols=1] |=== | Name | link:#fmt-generic_context-char_type[`char_type`] | link:#fmt-generic_context-iterator[`iterator`] |=== == Enums [cols=1] |=== | Name | link:#fmt-generic_context-_04enum[`Unnamed enum`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-generic_context-2constructor-01[`generic_context`] [.small]#[constructor]# [.small]#[deleted]# | Constructors | link:#fmt-generic_context-operator_assign[`operator=`] [.small]#[deleted]# | | link:#fmt-generic_context-advance_to[`advance_to`] | | link:#fmt-generic_context-arg-0f[`arg`] | | link:#fmt-generic_context-arg_id[`arg_id`] | | link:#fmt-generic_context-locale[`locale`] | | link:#fmt-generic_context-out[`out`] | |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using char_type = Char; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using iterator = OutputIt; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum Unnamed enum; ---- == Members [cols=1] |=== | Name | `builtin_types` |=== Constructors == Synopses Declared in `<fmt/format.h>` Copy constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-generic_context-2constructor-05[generic_context](link:#fmt-generic_context[generic_context] const& other) = delete; ---- [.small]#link:#fmt-generic_context-2constructor-05[_» more..._]# Move constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-generic_context-2constructor-04[generic_context](link:#fmt-generic_context[generic_context]&& other) = default; ---- [.small]#link:#fmt-generic_context-2constructor-04[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-generic_context-2constructor-00[generic_context]( OutputIt out, link:#fmt-basic_format_args[basic_format_args<generic_context>] args, link:#fmt-locale_ref[locale_ref] loc = {}); ---- [.small]#link:#fmt-generic_context-2constructor-00[_» more..._]# Copy constructor == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- generic_context(link:#fmt-generic_context[generic_context] const& other) = delete; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to copy construct from |=== Move constructor == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- generic_context(link:#fmt-generic_context[generic_context]&& other) = default; ---- == Parameters [cols=2] |=== | Name | Description | *other* | The object to move construct from |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr generic_context( OutputIt out, link:#fmt-basic_format_args[basic_format_args<generic_context>] args, link:#fmt-locale_ref[locale_ref] loc = {}); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void operator=(link:#fmt-generic_context[generic_context] const& other) = delete; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void advance_to(link:#fmt-generic_context-iterator[iterator] it); ---- == Synopses Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_format_arg[basic_format_arg<generic_context>] link:#fmt-generic_context-arg-09[arg](link:#fmt-basic_string_view[basic_string_view<Char>] name) const; ---- [.small]#link:#fmt-generic_context-arg-09[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_arg[basic_format_arg<generic_context>] link:#fmt-generic_context-arg-0d[arg](int id) const; ---- [.small]#link:#fmt-generic_context-arg-0d[_» more..._]# == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_format_arg[basic_format_arg<generic_context>] arg(link:#fmt-basic_string_view[basic_string_view<Char>] name) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-basic_format_arg[basic_format_arg<generic_context>] arg(int id) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr int arg_id(link:#fmt-basic_string_view[basic_string_view<Char>] name) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-locale_ref[locale_ref] locale() const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-generic_context-iterator[iterator] out() const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> struct group_digits_view; ---- == Data Members [cols=1] |=== | Name | link:#fmt-group_digits_view-value[`value`] |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-group_digits[`group_digits`] | Returns a view that formats an integer value using ',' as a locale‐independent thousands separator. |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- T value; ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename S> struct is_compiled_string : std::is_base_of<compiled_string, S> ---- == Base Classes [cols=2] |=== | Name | Description | `std::is_base_of<compiled_string, S>` | |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> struct is_contiguous : std::false_type ---- == Base Classes [cols=2] |=== | Name | Description | `std::false_type` | |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, size_t SIZE, typename Allocator> struct link:#fmt-is_contiguous-05[is_contiguous]<link:#fmt-basic_memory_buffer[basic_memory_buffer<T, SIZE, Allocator>]> : std::true_type ---- == Base Classes [cols=2] |=== | Name | Description | `std::true_type` | |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, typename Traits, typename Allocator> struct link:#fmt-is_contiguous-05[is_contiguous]<std::basic_string<Char, Traits, Allocator>> : std::true_type ---- == Base Classes [cols=2] |=== | Name | Description | `std::true_type` | |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct is_range; ---- == Static Data Members [cols=1] |=== | Name | link:#fmt-is_range-value[`value`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- inline constexpr static bool value = detail::is_range_<T>::value && !detail::has_to_string_view<T>::value; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename C> struct is_tuple_formattable; ---- == Static Data Members [cols=1] |=== | Name | link:#fmt-is_tuple_formattable-value[`value`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- inline constexpr static bool value = detail::is_tuple_formattable_<T, C>::value; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> struct is_tuple_like; ---- == Static Data Members [cols=1] |=== | Name | link:#fmt-is_tuple_like-value[`value`] |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- inline constexpr static bool value = detail::is_tuple_like_<T>::value && !detail::is_range_<T>::value; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> struct is_variant_like; ---- == Static Data Members [cols=1] |=== | Name | link:#fmt-is_variant_like-value[`value`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- inline constexpr static bool value = detail::is_variant_like_<T>::value; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename It, typename Sentinel, typename Char = char> struct join_view : /* implementation-defined */ ---- == Base Classes [cols=2] |=== | Name | Description | `/* implementation-defined */` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-join_view-2constructor[`join_view`] [.small]#[constructor]# |=== == Data Members [cols=1] |=== | Name | link:#fmt-join_view-begin[`begin`] | link:#fmt-join_view-end[`end`] | link:#fmt-join_view-sep[`sep`] |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-join-02[`join`] | Returns a view that formats the iterator range `[begin, end)` with elements separated by `sep`. | link:#fmt-join-03a[`join`] | Returns a view that formats `range` with elements separated by `sep`. | link:#fmt-join-0d[`join`] | Returns an object that formats `std::initializer_list` with elements separated by `sep`. |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- join_view( It b, Sentinel e, link:#fmt-basic_string_view[basic_string_view<Char>] s); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- It begin; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- Sentinel end; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_string_view[basic_string_view<Char>] sep; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class loc_value; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-loc_value-2constructor-08[`loc_value`] [.small]#[constructor]# | Constructors | link:#fmt-loc_value-visit[`visit`] | |=== Constructors == Synopses Declared in `<fmt/format.h>` Construct from `T` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-loc_value-2constructor-0ec[loc_value](T value); ---- [.small]#link:#fmt-loc_value-2constructor-0ec[_» more..._]# Construct from `T` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-loc_value-2constructor-0ea[loc_value](T value); ---- [.small]#link:#fmt-loc_value-2constructor-0ea[_» more..._]# Construct from `T` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> loc_value(T value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The object to construct from |=== Construct from `T` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> loc_value(T value); ---- == Parameters [cols=2] |=== | Name | Description | *value* | The object to construct from |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Visitor> decltype(vis(0)) visit(Visitor&& vis); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class locale_ref; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-locale_ref-2constructor-0a[`locale_ref`] [.small]#[constructor]# | Constructors | link:#fmt-locale_ref-get[`get`] | | link:#fmt-locale_ref-2conversion[`operator bool`] | Conversion to `bool` |=== Constructors == Synopses Declared in `<fmt/base.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-locale_ref-2constructor-05[locale_ref](); ---- [.small]#link:#fmt-locale_ref-2constructor-05[_» more..._]# Construct from `Locale` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Locale> link:#fmt-locale_ref-2constructor-06[locale_ref](Locale const& loc); ---- [.small]#link:#fmt-locale_ref-2constructor-06[_» more..._]# Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr locale_ref(); ---- Construct from `Locale` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Locale> locale_ref(Locale const& loc); ---- == Parameters [cols=2] |=== | Name | Description | *loc* | The object to copy construct from |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Locale> Locale get() const; ---- Conversion to `bool` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- explicit operator bool() const noexcept; ---- == Return Value The object converted to `bool` == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- struct monostate; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-monostate-2constructor[`monostate`] [.small]#[constructor]# | Default constructor |=== Default constructor == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr monostate(); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class month; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-month-2constructor-0a8[`month`] [.small]#[constructor]# | Constructors | link:#fmt-month-2conversion[`operator unsigned int`] | Conversion to `unsigned int` |=== Constructors == Synopses Declared in `<fmt/chrono.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-month-2constructor-09[month]() = default; ---- [.small]#link:#fmt-month-2constructor-09[_» more..._]# Construct from `unsigned int` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-month-2constructor-0a4[month](unsigned int m) noexcept; ---- [.small]#link:#fmt-month-2constructor-0a4[_» more..._]# Default constructor == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr month() = default; ---- Construct from `unsigned int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit month(unsigned int m) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *m* | The value to construct from |=== Conversion to `unsigned int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit operator unsigned int() const noexcept; ---- == Return Value The object converted to `unsigned int` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char = char> struct nested_formatter; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-nested_formatter-2constructor[`nested_formatter`] [.small]#[constructor]# | Default constructor | link:#fmt-nested_formatter-nested[`nested`] | | link:#fmt-nested_formatter-parse[`parse`] | | link:#fmt-nested_formatter-write_padded[`write_padded`] | |=== == Derived Classes [cols=2] |=== | Name | Description | link:#fmt-formatter-0f[`formatter`] | |=== Default constructor == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr nested_formatter(); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-nested_view[nested_view<T, Char>] nested(T const& value) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename FormatContext, typename F> decltype(ctx.out()) write_padded( FormatContext& ctx, F write) const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> struct nested_view; ---- == Data Members [cols=1] |=== | Name | link:#fmt-nested_view-fmt[`fmt`] | link:#fmt-nested_view-value[`value`] |=== == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-formatter-02b[formatter<T, Char>] const* fmt; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- T const* value; ---- Parsing context consisting of a format string range being parsed and an argument counter for automatic indexing. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char = char> class parse_context; ---- == Types [cols=1] |=== | Name | link:#fmt-parse_context-0f-char_type[`char_type`] | link:#fmt-parse_context-0f-iterator[`iterator`] |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-parse_context-0f-2constructor[`parse_context`] [.small]#[constructor]# | | link:#fmt-parse_context-0f-advance_to[`advance_to`] | Advances the begin iterator to `it`. | link:#fmt-parse_context-0f-begin[`begin`] | Returns an iterator to the beginning of the format string range being parsed. | link:#fmt-parse_context-0f-check_arg_id-0d[`check_arg_id`] | Reports an error if using the automatic argument indexing; otherwise switches to the manual indexing. | link:#fmt-parse_context-0f-check_dynamic_spec[`check_dynamic_spec`] | | link:#fmt-parse_context-0f-end[`end`] | Returns an iterator past the end of the format string range being parsed. | link:#fmt-parse_context-0f-next_arg_id[`next_arg_id`] | Reports an error if using the manual argument indexing; otherwise returns the next argument index and switches to the automatic indexing. |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using char_type = Char; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using iterator = Char const*; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit parse_context( link:#fmt-basic_string_view[basic_string_view<Char>] fmt, int next_arg_id = 0); ---- Advances the begin iterator to `it`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void advance_to(link:#fmt-parse_context-0f-iterator[iterator] it); ---- Returns an iterator to the beginning of the format string range being parsed. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-parse_context-0f-iterator[iterator] begin() const noexcept; ---- Reports an error if using the automatic argument indexing; otherwise switches to the manual indexing. == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void link:#fmt-parse_context-0f-check_arg_id-09[check_arg_id](link:#fmt-basic_string_view[basic_string_view<Char>]); ---- [.small]#link:#fmt-parse_context-0f-check_arg_id-09[_» more..._]# Reports an error if using the automatic argument indexing; otherwise switches to the manual indexing. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void link:#fmt-parse_context-0f-check_arg_id-07[check_arg_id](int id); ---- [.small]#link:#fmt-parse_context-0f-check_arg_id-07[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void check_arg_id(link:#fmt-basic_string_view[basic_string_view<Char>]); ---- Reports an error if using the automatic argument indexing; otherwise switches to the manual indexing. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void check_arg_id(int id); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void check_dynamic_spec(int arg_id); ---- Returns an iterator past the end of the format string range being parsed. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-parse_context-0f-iterator[iterator] end() const noexcept; ---- == Return Value an iterator past the end of the format string range being parsed. Reports an error if using the manual argument indexing; otherwise returns the next argument index and switches to the automatic indexing. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr int next_arg_id(); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<> class link:#fmt-parse_context-0f[parse_context]<char>; ---- == Types [cols=1] |=== | Name | link:#fmt-parse_context-00-char_type[`char_type`] | link:#fmt-parse_context-00-iterator[`iterator`] |=== == Member Functions [cols=1] |=== | Name | link:#fmt-parse_context-00-2constructor[`parse_context`] [.small]#[constructor]# | link:#fmt-parse_context-00-advance_to[`advance_to`] | link:#fmt-parse_context-00-begin[`begin`] | link:#fmt-parse_context-00-check_arg_id-05[`check_arg_id`] | link:#fmt-parse_context-00-check_dynamic_spec[`check_dynamic_spec`] | link:#fmt-parse_context-00-end[`end`] | link:#fmt-parse_context-00-next_arg_id[`next_arg_id`] |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using char_type = char; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using iterator = char const*; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit parse_context( link:#fmt-basic_string_view[basic_string_view<char>] fmt, int next_arg_id = 0); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void advance_to(link:#fmt-parse_context-00-iterator[iterator] it); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-parse_context-00-iterator[iterator] begin() const noexcept; ---- == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void link:#fmt-parse_context-00-check_arg_id-07[check_arg_id](link:#fmt-basic_string_view[basic_string_view<char>]); ---- [.small]#link:#fmt-parse_context-00-check_arg_id-07[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void link:#fmt-parse_context-00-check_arg_id-06[check_arg_id](int id); ---- [.small]#link:#fmt-parse_context-00-check_arg_id-06[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void check_arg_id(link:#fmt-basic_string_view[basic_string_view<char>]); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void check_arg_id(int id); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void check_dynamic_spec(int arg_id); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-parse_context-00-iterator[iterator] end() const noexcept; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr int next_arg_id(); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class path : public std::filesystem::path ---- == Base Classes [cols=2] |=== | Name | Description | `std::filesystem::path` | |=== == Member Functions [cols=1] |=== | Name | link:#fmt-path-display_string[`display_string`] | link:#fmt-path-generic_display_string[`generic_display_string`] | link:#fmt-path-generic_system_string[`generic_system_string`] | link:#fmt-path-system_string[`system_string`] |=== == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string display_string() const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string generic_display_string() const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string generic_system_string() const; ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string system_string() const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char, typename Enable = void> struct range_format_kind : link:#fmt-conditional_t[conditional_t<is_range<T, Char>::value, /* implementation-defined */, std::integral_constant<range_format, range_format::disabled>>] ---- == Base Classes [cols=2] |=== | Name | Description | `link:#fmt-conditional_t[conditional_t<is_range<T, Char>::value, /* implementation-defined */, std::integral_constant<range_format, range_format::disabled>>]` | |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char, typename Enable = void> struct range_formatter; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char> requires conjunction<std::is_same<T, remove_cvref_t<T>>, is_formattable<T, Char>>::value struct link:#fmt-range_formatter-00[range_formatter]<T, Char>; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-range_formatter-07-2constructor[`range_formatter`] [.small]#[constructor]# | Default constructor | link:#fmt-range_formatter-07-format[`format`] | | link:#fmt-range_formatter-07-parse[`parse`] | | link:#fmt-range_formatter-07-set_brackets[`set_brackets`] | | link:#fmt-range_formatter-07-set_separator[`set_separator`] | | link:#fmt-range_formatter-07-underlying[`underlying`] | |=== Default constructor == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr range_formatter(); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename R, typename FormatContext> decltype(ctx.out()) format( R&& range, FormatContext& ctx) const; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr Char const* parse(link:#fmt-parse_context-0f[parse_context<Char>]& ctx); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_brackets( link:#fmt-basic_string_view[basic_string_view<Char>] open, link:#fmt-basic_string_view[basic_string_view<Char>] close); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr void set_separator(link:#fmt-basic_string_view[basic_string_view<Char>] sep); ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr /* implementation-defined */& underlying(); ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- struct rgb; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-rgb-2constructor-06b7[`rgb`] [.small]#[constructor]# | Constructors |=== == Data Members [cols=1] |=== | Name | link:#fmt-rgb-b[`b`] | link:#fmt-rgb-g[`g`] | link:#fmt-rgb-r[`r`] |=== Constructors == Synopses Declared in `<fmt/color.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-rgb-2constructor-06b9[rgb](); ---- [.small]#link:#fmt-rgb-2constructor-06b9[_» more..._]# Construct from `color` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-rgb-2constructor-04[rgb](link:#fmt-color[color] hex); ---- [.small]#link:#fmt-rgb-2constructor-04[_» more..._]# Construct from `uint32_t` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-rgb-2constructor-08[rgb](uint32_t hex); ---- [.small]#link:#fmt-rgb-2constructor-08[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-rgb-2constructor-09[rgb]( uint8_t r_, uint8_t g_, uint8_t b_); ---- [.small]#link:#fmt-rgb-2constructor-09[_» more..._]# Default constructor == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr rgb(); ---- Construct from `color` == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr rgb(link:#fmt-color[color] hex); ---- == Parameters [cols=2] |=== | Name | Description | *hex* | The object to construct from |=== Construct from `uint32_t` == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr rgb(uint32_t hex); ---- == Parameters [cols=2] |=== | Name | Description | *hex* | The object to construct from |=== == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr rgb( uint8_t r_, uint8_t g_, uint8_t b_); ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- uint8_t b; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- uint8_t g; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- uint8_t r; ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char = char> struct runtime_format_string; ---- == Data Members [cols=1] |=== | Name | link:#fmt-runtime_format_string-str[`str`] |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-runtime-0a[`runtime`] | Creates a runtime format string. |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_string_view[basic_string_view<Char>] str; ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t N> class static_format_result; ---- == Member Functions [cols=1] |=== | Name | link:#fmt-static_format_result-2constructor[`static_format_result`] [.small]#[constructor]# | link:#fmt-static_format_result-c_str[`c_str`] | link:#fmt-static_format_result-str[`str`] |=== == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> constexpr explicit static_format_result( S const& fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- char const* c_str() const; ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-string_view[fmt::string_view] str() const; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class string_buffer; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-string_buffer-2constructor[`string_buffer`] [.small]#[constructor]# | Default constructor | link:#fmt-string_buffer-str[`str`] | | link:#fmt-string_buffer-2conversion[`operator writer`] | Conversion to `writer` |=== Default constructor == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- string_buffer(); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string& str(); ---- Conversion to `writer` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- operator link:#fmt-writer[writer](); ---- == Return Value The object converted to `writer` A text style consisting of foreground and background colors and emphasis. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class text_style; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-text_style-2constructor[`text_style`] [.small]#[constructor]# | Construct from `emphasis` | link:#fmt-text_style-get_background[`get_background`] | | link:#fmt-text_style-get_emphasis[`get_emphasis`] | | link:#fmt-text_style-get_foreground[`get_foreground`] | | link:#fmt-text_style-has_background[`has_background`] | | link:#fmt-text_style-has_emphasis[`has_emphasis`] | | link:#fmt-text_style-has_foreground[`has_foreground`] | | link:#fmt-text_style-operator_or_eq[`operator|=`] | Bitwise disjunction assignment operator | link:#fmt-text_style-operator_eq[`operator==`] | Equality operator | link:#fmt-text_style-operator_not_eq[`operator!=`] | Inequality operator |=== == Friends [cols=2] |=== | Name | Description | `link:#fmt-bg[fmt::bg]` | Creates a text style from the background color. | `link:#fmt-fg[fmt::fg]` | Creates a text style from the foreground (text) color. | `link:#fmt-operator_bitor-00[fmt::operator|]` | Bitwise disjunction operator |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-format-07[`format`] | Formats arguments and returns the result as a string using ANSI escape sequences to specify text formatting. | link:#fmt-operator_bitor-06[`operator|`] | Bitwise disjunction operator | link:#fmt-print-0c[`print`] | Formats a string and prints it to stdout using ANSI escape sequences to specify text formatting. |=== Construct from `emphasis` == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr text_style(link:#fmt-emphasis[emphasis] em = emphasis()) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *em* | The object to construct from |=== == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr /* implementation-defined */ get_background() const noexcept; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-emphasis[emphasis] get_emphasis() const noexcept; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr /* implementation-defined */ get_foreground() const noexcept; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool has_background() const noexcept; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool has_emphasis() const noexcept; ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool has_foreground() const noexcept; ---- Bitwise disjunction assignment operator == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style]& operator|=(link:#fmt-text_style[text_style] rhs); ---- == Return Value Reference to the current object == Parameters [cols=2] |=== | Name | Description | *rhs* | The right operand |=== Equality operator == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool operator==(link:#fmt-text_style[text_style] rhs) const noexcept; ---- == Return Value `true` if the objects are equal, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *rhs* | The right operand |=== Inequality operator == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool operator!=(link:#fmt-text_style[text_style] rhs) const noexcept; ---- == Return Value `true` if the objects are not equal, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *rhs* | The right operand |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Tuple, typename Char> struct tuple_join_view : /* implementation-defined */ ---- == Base Classes [cols=2] |=== | Name | Description | `/* implementation-defined */` | |=== == Member Functions [cols=2] |=== | Name | Description | link:#fmt-tuple_join_view-2constructor[`tuple_join_view`] [.small]#[constructor]# | Constructor |=== == Data Members [cols=1] |=== | Name | link:#fmt-tuple_join_view-sep[`sep`] | link:#fmt-tuple_join_view-tuple[`tuple`] |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-join-08[`join`] | Returns an object that formats `std::tuple` with elements separated by `sep`. |=== Constructor == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- tuple_join_view( Tuple const& t, link:#fmt-basic_string_view[basic_string_view<Char>] s); ---- == Parameters [cols=2] |=== | Name | Description | *t* | The object to copy construct from | *s* | An implementation of `std::basic_string_view` for pre‐C++17. It provides a subset of the API. `fmt::basic_string_view` is used for format strings even if `std::basic_string_view` is available to prevent issues when a library is compiled with a different `‐std` option than the client code (which is not recommended). |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-basic_string_view[basic_string_view<Char>] sep; ---- == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- Tuple const& tuple; ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> struct vprintf_args; ---- == Types [cols=1] |=== | Name | link:#fmt-vprintf_args-type[`type`] |=== == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- using type = link:#fmt-basic_format_args[basic_format_args<basic_printf_context<Char>>]; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class weekday; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-weekday-2constructor-0d[`weekday`] [.small]#[constructor]# | Constructors | link:#fmt-weekday-c_encoding[`c_encoding`] | |=== Constructors == Synopses Declared in `<fmt/chrono.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-weekday-2constructor-03[weekday]() = default; ---- [.small]#link:#fmt-weekday-2constructor-03[_» more..._]# Construct from `unsigned int` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-weekday-2constructor-0a[weekday](unsigned int wd) noexcept; ---- [.small]#link:#fmt-weekday-2constructor-0a[_» more..._]# Default constructor == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr weekday() = default; ---- Construct from `unsigned int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit weekday(unsigned int wd) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *wd* | The value to construct from |=== == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr unsigned int c_encoding() const noexcept; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class writer; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-writer-2constructor-08[`writer`] [.small]#[constructor]# | Constructors | link:#fmt-writer-print[`print`] | Formats `args` according to specifications in `fmt` and writes the output to the file. |=== Constructors == Synopses Declared in `<fmt/format.h>` Construct from `buffer` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-writer-2constructor-00[writer](/* implementation-defined */& buf); ---- [.small]#link:#fmt-writer-2constructor-00[_» more..._]# Construct from `FILE` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-writer-2constructor-05[writer](FILE* f); ---- [.small]#link:#fmt-writer-2constructor-05[_» more..._]# Construct from `buffer` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- writer(/* implementation-defined */& buf); ---- == Parameters [cols=2] |=== | Name | Description | *buf* | The object to copy construct from |=== Construct from `FILE` == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- writer(FILE* f); ---- == Parameters [cols=2] |=== | Name | Description | *f* | The object to construct from |=== Formats `args` according to specifications in `fmt` and writes the output to the file. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class year; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-year-2constructor-027[`year`] [.small]#[constructor]# | Constructors | link:#fmt-year-2conversion[`operator int`] | Conversion to `int` |=== Constructors == Synopses Declared in `<fmt/chrono.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-year-2constructor-0f[year]() = default; ---- [.small]#link:#fmt-year-2constructor-0f[_» more..._]# Construct from `int` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit link:#fmt-year-2constructor-02a[year](int y) noexcept; ---- [.small]#link:#fmt-year-2constructor-02a[_» more..._]# Default constructor == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr year() = default; ---- Construct from `int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit year(int y) noexcept; ---- == Parameters [cols=2] |=== | Name | Description | *y* | The value to construct from |=== Conversion to `int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr explicit operator int() const noexcept; ---- == Return Value The object converted to `int` == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class year_month_day; ---- == Member Functions [cols=2] |=== | Name | Description | link:#fmt-year_month_day-2constructor-0a[`year_month_day`] [.small]#[constructor]# | Constructors | link:#fmt-year_month_day-day[`day`] | | link:#fmt-year_month_day-month[`month`] | | link:#fmt-year_month_day-year[`year`] | |=== Constructors == Synopses Declared in `<fmt/chrono.h>` Default constructor [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-year_month_day-2constructor-0f[year_month_day]() = default; ---- [.small]#link:#fmt-year_month_day-2constructor-0f[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-year_month_day-2constructor-04[year_month_day]( link:#fmt-year[year] const& y, link:#fmt-month[month] const& m, link:#fmt-day[day] const& d) noexcept; ---- [.small]#link:#fmt-year_month_day-2constructor-04[_» more..._]# Default constructor == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr year_month_day() = default; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr year_month_day( link:#fmt-year[year] const& y, link:#fmt-month[month] const& m, link:#fmt-day[day] const& d) noexcept; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-day[fmt::day] day() const noexcept; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-month[fmt::month] month() const noexcept; ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-year[fmt::year] year() const noexcept; ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum Unnamed enum; ---- == Members [cols=1] |=== | Name | `inline_buffer_size` |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class align : int; ---- == Members [cols=1] |=== | Name | `none` | `left` | `right` | `center` | `numeric` |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class arg_id_kind : int; ---- == Members [cols=1] |=== | Name | `none` | `index` | `name` |=== == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class color : uint32_t; ---- == Members [cols=1] |=== | Name | `alice_blue` | `antique_white` | `aqua` | `aquamarine` | `azure` | `beige` | `bisque` | `black` | `blanched_almond` | `blue` | `blue_violet` | `brown` | `burly_wood` | `cadet_blue` | `chartreuse` | `chocolate` | `coral` | `cornflower_blue` | `cornsilk` | `crimson` | `cyan` | `dark_blue` | `dark_cyan` | `dark_golden_rod` | `dark_gray` | `dark_green` | `dark_khaki` | `dark_magenta` | `dark_olive_green` | `dark_orange` | `dark_orchid` | `dark_red` | `dark_salmon` | `dark_sea_green` | `dark_slate_blue` | `dark_slate_gray` | `dark_turquoise` | `dark_violet` | `deep_pink` | `deep_sky_blue` | `dim_gray` | `dodger_blue` | `fire_brick` | `floral_white` | `forest_green` | `fuchsia` | `gainsboro` | `ghost_white` | `gold` | `golden_rod` | `gray` | `green` | `green_yellow` | `honey_dew` | `hot_pink` | `indian_red` | `indigo` | `ivory` | `khaki` | `lavender` | `lavender_blush` | `lawn_green` | `lemon_chiffon` | `light_blue` | `light_coral` | `light_cyan` | `light_golden_rod_yellow` | `light_gray` | `light_green` | `light_pink` | `light_salmon` | `light_sea_green` | `light_sky_blue` | `light_slate_gray` | `light_steel_blue` | `light_yellow` | `lime` | `lime_green` | `linen` | `magenta` | `maroon` | `medium_aquamarine` | `medium_blue` | `medium_orchid` | `medium_purple` | `medium_sea_green` | `medium_slate_blue` | `medium_spring_green` | `medium_turquoise` | `medium_violet_red` | `midnight_blue` | `mint_cream` | `misty_rose` | `moccasin` | `navajo_white` | `navy` | `old_lace` | `olive` | `olive_drab` | `orange` | `orange_red` | `orchid` | `pale_golden_rod` | `pale_green` | `pale_turquoise` | `pale_violet_red` | `papaya_whip` | `peach_puff` | `peru` | `pink` | `plum` | `powder_blue` | `purple` | `rebecca_purple` | `red` | `rosy_brown` | `royal_blue` | `saddle_brown` | `salmon` | `sandy_brown` | `sea_green` | `sea_shell` | `sienna` | `silver` | `sky_blue` | `slate_blue` | `slate_gray` | `snow` | `spring_green` | `steel_blue` | `tan` | `teal` | `thistle` | `tomato` | `turquoise` | `violet` | `wheat` | `white` | `white_smoke` | `yellow` | `yellow_green` |=== == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class emphasis : uint8_t; ---- == Members [cols=1] |=== | Name | `bold` | `faint` | `italic` | `underline` | `blink` | `reverse` | `conceal` | `strikethrough` |=== == Non-Member Functions [cols=2] |=== | Name | Description | link:#fmt-operator_bitor-06[`operator|`] | Bitwise disjunction operator |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class presentation_type : unsigned char; ---- == Members [cols=1] |=== | Name | `none` | `debug` | `string` | `dec` | `hex` | `oct` | `bin` | `chr` | `pointer` | `exp` | `fixed` | `general` | `hexfloat` |=== == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class range_format : int; ---- == Members [cols=1] |=== | Name | `disabled` | `map` | `set` | `sequence` | `string` | `debug_string` |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class sign : int; ---- == Members [cols=1] |=== | Name | `none` | `minus` | `plus` | `space` |=== == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- enum class terminal_color : uint8_t; ---- == Members [cols=1] |=== | Name | `black` | `red` | `green` | `yellow` | `blue` | `magenta` | `cyan` | `white` | `bright_black` | `bright_red` | `bright_green` | `bright_yellow` | `bright_blue` | `bright_magenta` | `bright_cyan` | `bright_white` |=== == Synopses Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template</* implementation-defined */ S> constexpr auto link:#fmt-2function-0b[Unnamed function](); ---- [.small]#link:#fmt-2function-0b[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template</* implementation-defined */ Str> constexpr auto link:#fmt-2function-08[Unnamed function](); ---- [.small]#link:#fmt-2function-08[_» more..._]# == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template</* implementation-defined */ S> constexpr auto Unnamed function(); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template</* implementation-defined */ Str> constexpr auto Unnamed function(); ---- Returns a named argument to be used in a formatting function. It should only be used in a call to a formatting function. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char, typename T> /* implementation-defined */ arg( Char const* name, T const& arg); ---- == Description *Example*: fmt::print("The answer is {answer}.", fmt::arg("answer", 42)); == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- [[noreturn]] void assert_fail( char const* file, int line, char const* message); ---- Creates a text style from the background color. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style] bg(/* implementation-defined */ background) noexcept; ---- == Return Value A text style consisting of foreground and background colors and emphasis. Creates a text style from the foreground (text) color. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style] fg(/* implementation-defined */ foreground) noexcept; ---- == Return Value A text style consisting of foreground and background colors and emphasis. `format` overloads == Synopses Declared in `<fmt/color.h>` Formats `args` according to specifications in `fmt` and returns the result as a string. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[nodiscard, always_inline]] std::string link:#fmt-format-05[format]( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format-05[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::wstring link:#fmt-format-0f[format]( link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format-0f[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> [[always_inline]] constexpr std::basic_string<S::char_type> link:#fmt-format-0b[format]( S const&, T...&&... args); ---- [.small]#link:#fmt-format-0b[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename CompiledFormat, typename... T, typename Char = CompiledFormat::char_type> [[always_inline]] constexpr std::basic_string<Char> link:#fmt-format-049[format]( CompiledFormat const& cf, T const...&... args); ---- [.small]#link:#fmt-format-049[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T, typename Char = /* implementation-defined */> std::basic_string<Char> link:#fmt-format-01[format]( S const& fmt, T...&&... args); ---- [.small]#link:#fmt-format-01[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] std::string link:#fmt-format-0a[format]( link:#fmt-locale_ref[locale_ref] loc, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format-0a[_» more..._]# Formats arguments and returns the result as a string using ANSI escape sequences to specify text formatting. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::string link:#fmt-format-07[format]( link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format-07[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::wstring link:#fmt-format-09[format]( link:#fmt-text_style[text_style] ts, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format-09[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T, typename Char = /* implementation-defined */> std::basic_string<Char> link:#fmt-format-047[format]( link:#fmt-locale_ref[locale_ref] loc, S const& fmt, T...&&... args); ---- [.small]#link:#fmt-format-047[_» more..._]# Formats `args` according to specifications in `fmt` and returns the result as a string. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[nodiscard, always_inline]] std::string format( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: #include <fmt/format.h> std::string message = fmt::format("The answer is {}.", 42); == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::wstring format( link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> [[always_inline]] constexpr std::basic_string<S::char_type> format( S const&, T...&&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename CompiledFormat, typename... T, typename Char = CompiledFormat::char_type> [[always_inline]] constexpr std::basic_string<Char> format( CompiledFormat const& cf, T const...&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T, typename Char = /* implementation-defined */> std::basic_string<Char> format( S const& fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] std::string format( link:#fmt-locale_ref[locale_ref] loc, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- Formats arguments and returns the result as a string using ANSI escape sequences to specify text formatting. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::string format( link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: ``` #include <fmt/color.h> std::string message = fmt::format(fmt::emphasis::bold | fg(fmt::color::red), "The answer is {}", 42); ``` == Parameters [cols=2] |=== | Name | Description | *ts* | A text style consisting of foreground and background colors and emphasis. |=== == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::wstring format( link:#fmt-text_style[text_style] ts, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T, typename Char = /* implementation-defined */> std::basic_string<Char> format( link:#fmt-locale_ref[locale_ref] loc, S const& fmt, T...&&... args); ---- Formats an error message for an error returned by an operating system or a language runtime, for example a file opening error, and writes it to `out`. The format is the same as the one used by `std::system_error(ec, message)` where `ec` is `std::error_code(error_code, std::generic_category())`. It is implementation‐defined but normally looks like: == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void format_system_error( /* implementation-defined */& out, int error_code, char const* message) noexcept; ---- == Description <message>: <system‐message> where `<message>` is the passed message and `<system‐message>` is the system message corresponding to the error code. `error_code` is a system error code as given by `errno`. == Parameters [cols=2] |=== | Name | Description | *out* | A contiguous memory buffer with an optional growing ability. It is an internal class and shouldn't be used directly, only via `memory_buffer`. |=== `format_to` overloads == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> OutputIt link:#fmt-format_to-06[format_to]( OutputIt out, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format_to-06[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< size_t N, typename... T> [[always_inline]] link:#fmt-format_to_result[format_to_result] link:#fmt-format_to-02[format_to]( char(& out)[], link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format_to-02[_» more..._]# Formats `args` according to specifications in `fmt`, writes the result to the output iterator `out` and returns the iterator past the end of the output range. `format_to` does not append a terminating null character. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> [[always_inline]] link:#fmt-remove_cvref_t[remove_cvref_t<OutputIt>] link:#fmt-format_to-09[format_to]( OutputIt&& out, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format_to-09[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename CompiledFormat, typename... T> [[always_inline]] constexpr OutputIt link:#fmt-format_to-0c[format_to]( OutputIt out, CompiledFormat const& cf, T const...&... args); ---- [.small]#link:#fmt-format_to-0c[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T> constexpr OutputIt link:#fmt-format_to-00[format_to]( OutputIt out, S const&, T...&&... args); ---- [.small]#link:#fmt-format_to-00[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T, typename Char = /* implementation-defined */> OutputIt link:#fmt-format_to-08[format_to]( OutputIt out, S const& fmt, T...&&... args); ---- [.small]#link:#fmt-format_to-08[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> [[always_inline]] OutputIt link:#fmt-format_to-05[format_to]( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format_to-05[_» more..._]# Formats arguments with the given text style, writes the result to the output iterator `out` and returns the iterator past the end of the output range. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> OutputIt link:#fmt-format_to-0d8[format_to]( OutputIt out, link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format_to-0d8[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T, typename Char = /* implementation-defined */, bool enable = detail::is_output_iterator<OutputIt, Char>::value && detail::is_exotic_char<Char>::value> OutputIt link:#fmt-format_to-04[format_to]( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, S const& fmt, T...&&... args) requires enable; ---- [.small]#link:#fmt-format_to-04[_» more..._]# == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> OutputIt format_to( OutputIt out, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< size_t N, typename... T> [[always_inline]] link:#fmt-format_to_result[format_to_result] format_to( char(& out)[], link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- Formats `args` according to specifications in `fmt`, writes the result to the output iterator `out` and returns the iterator past the end of the output range. `format_to` does not append a terminating null character. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> [[always_inline]] link:#fmt-remove_cvref_t[remove_cvref_t<OutputIt>] format_to( OutputIt&& out, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: auto out = std::vector<char>(); fmt::format_to(std::back_inserter(out), "{}", 42); == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename CompiledFormat, typename... T> [[always_inline]] constexpr OutputIt format_to( OutputIt out, CompiledFormat const& cf, T const...&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T> constexpr OutputIt format_to( OutputIt out, S const&, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T, typename Char = /* implementation-defined */> OutputIt format_to( OutputIt out, S const& fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> [[always_inline]] OutputIt format_to( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- Formats arguments with the given text style, writes the result to the output iterator `out` and returns the iterator past the end of the output range. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> OutputIt format_to( OutputIt out, link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: std::vector<char> out; fmt::format_to(std::back_inserter(out), fmt::emphasis::bold | fg(fmt::color::red), "{}", 42); == Parameters [cols=2] |=== | Name | Description | *ts* | A text style consisting of foreground and background colors and emphasis. |=== == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T, typename Char = /* implementation-defined */, bool enable = detail::is_output_iterator<OutputIt, Char>::value && detail::is_exotic_char<Char>::value> OutputIt format_to( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, S const& fmt, T...&&... args) requires enable; ---- Formats `args` according to specifications in `fmt`, writes up to `n` characters of the result to the output iterator `out` and returns the total (not truncated) output size and the iterator past the end of the output range. `format_to_n` does not append a terminating null character. == Synopses Declared in `<fmt/base.h>` Formats `args` according to specifications in `fmt`, writes up to `n` characters of the result to the output iterator `out` and returns the total (not truncated) output size and the iterator past the end of the output range. `format_to_n` does not append a terminating null character. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> [[always_inline]] link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] link:#fmt-format_to_n-04[format_to_n]( OutputIt out, size_t n, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-format_to_n-04[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] link:#fmt-format_to_n-00[format_to_n]( OutputIt out, size_t n, S const& fmt, T...&&... args); ---- [.small]#link:#fmt-format_to_n-00[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T, typename Char = /* implementation-defined */> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] link:#fmt-format_to_n-0c[format_to_n]( OutputIt out, size_t n, S const& fmt, T...&&... args); ---- [.small]#link:#fmt-format_to_n-0c[_» more..._]# Formats `args` according to specifications in `fmt`, writes up to `n` characters of the result to the output iterator `out` and returns the total (not truncated) output size and the iterator past the end of the output range. `format_to_n` does not append a terminating null character. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> [[always_inline]] link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] format_to_n( OutputIt out, size_t n, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] format_to_n( OutputIt out, size_t n, S const& fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename... T, typename Char = /* implementation-defined */> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] format_to_n( OutputIt out, size_t n, S const& fmt, T...&&... args); ---- Returns the number of chars in the output of `format(fmt, args...)`. == Synopses Declared in `<fmt/base.h>` Returns the number of chars in the output of `format(fmt, args...)`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[nodiscard, always_inline]] size_t link:#fmt-formatted_size-07[formatted_size]( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-formatted_size-07[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> constexpr size_t link:#fmt-formatted_size-03[formatted_size]( S const& fmt, T...&&... args); ---- [.small]#link:#fmt-formatted_size-03[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T, typename Char = /* implementation-defined */> size_t link:#fmt-formatted_size-0e6[formatted_size]( S const& fmt, T...&&... args); ---- [.small]#link:#fmt-formatted_size-0e6[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[nodiscard, always_inline]] size_t link:#fmt-formatted_size-0b[formatted_size]( link:#fmt-locale_ref[locale_ref] loc, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-formatted_size-0b[_» more..._]# Returns the number of chars in the output of `format(fmt, args...)`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[nodiscard, always_inline]] size_t formatted_size( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Return Value the number of chars in the output of `format(fmt, args...)`. == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> constexpr size_t formatted_size( S const& fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T, typename Char = /* implementation-defined */> size_t formatted_size( S const& fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[nodiscard, always_inline]] size_t formatted_size( link:#fmt-locale_ref[locale_ref] loc, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- Formats `args` according to specifications in `fmt` and writes the output to `f`. == Synopses Declared in `<fmt/printf.h>` Formats `args` according to specifications in `fmt` and writes the output to `f`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> int link:#fmt-fprintf-0b9[fprintf]( FILE* f, link:#fmt-string_view[string_view] fmt, T const...&... args); ---- [.small]#link:#fmt-fprintf-0b9[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[deprecated]] int link:#fmt-fprintf-09[fprintf]( FILE* f, link:#fmt-basic_string_view[basic_string_view<wchar_t>] fmt, T const...&... args); ---- [.small]#link:#fmt-fprintf-09[_» more..._]# Formats `args` according to specifications in `fmt` and writes the output to `f`. == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> int fprintf( FILE* f, link:#fmt-string_view[string_view] fmt, T const...&... args); ---- == Description *Example*: fmt::fprintf(stderr, "Don't %s!", "panic"); == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[deprecated]] int fprintf( FILE* f, link:#fmt-basic_string_view[basic_string_view<wchar_t>] fmt, T const...&... args); ---- Converts given time since epoch as `std::time_t` value into calendar time, expressed in Coordinated Universal Time (UTC). Unlike `std::gmtime`, this function is thread‐safe on most platforms. == Synopses Declared in `<fmt/chrono.h>` Converts given time since epoch as `std::time_t` value into calendar time, expressed in Coordinated Universal Time (UTC). Unlike `std::gmtime`, this function is thread‐safe on most platforms. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- tm link:#fmt-gmtime-0f[gmtime](time_t time); ---- [.small]#link:#fmt-gmtime-0f[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Duration> tm link:#fmt-gmtime-08[gmtime](link:#fmt-sys_time[sys_time<Duration>] time_point); ---- [.small]#link:#fmt-gmtime-08[_» more..._]# Converts given time since epoch as `std::time_t` value into calendar time, expressed in Coordinated Universal Time (UTC). Unlike `std::gmtime`, this function is thread‐safe on most platforms. == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- tm gmtime(time_t time); ---- == Synopsis Declared in `<fmt/chrono.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Duration> tm gmtime(link:#fmt-sys_time[sys_time<Duration>] time_point); ---- Returns a view that formats an integer value using ',' as a locale‐independent thousands separator. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-group_digits_view[group_digits_view<T>] group_digits(T value); ---- == Description *Example*: fmt::print("{}", fmt::group_digits(12345)); // Output: "12,345" `join` overloads == Synopses Declared in `<fmt/ranges.h>` Returns an object that formats `std::initializer_list` with elements separated by `sep`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-join_view[join_view<T const*, T const*>] link:#fmt-join-0d[join]( std::initializer_list<T> list, link:#fmt-string_view[string_view] sep); ---- [.small]#link:#fmt-join-0d[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-join_view[join_view<T const*, T const*, wchar_t>] link:#fmt-join-0f[join]( std::initializer_list<T> list, link:#fmt-wstring_view[wstring_view] sep); ---- [.small]#link:#fmt-join-0f[_» more..._]# Returns an object that formats `std::tuple` with elements separated by `sep`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Tuple> constexpr link:#fmt-tuple_join_view[tuple_join_view<Tuple, char>] link:#fmt-join-08[join]( Tuple const& tuple, link:#fmt-string_view[string_view] sep); ---- [.small]#link:#fmt-join-08[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Tuple> link:#fmt-tuple_join_view[tuple_join_view<Tuple, wchar_t>] link:#fmt-join-0ab[join]( Tuple const& tuple, link:#fmt-basic_string_view[basic_string_view<wchar_t>] sep); ---- [.small]#link:#fmt-join-0ab[_» more..._]# Returns a view that formats `range` with elements separated by `sep`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Range> link:#fmt-join_view[join_view<decltype(detail::range_begin(r)), decltype(detail::range_end(r))>] link:#fmt-join-03a[join]( Range&& r, link:#fmt-string_view[string_view] sep); ---- [.small]#link:#fmt-join-03a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Range> link:#fmt-join_view[join_view<decltype(std::begin(range)), decltype(std::end(range)), wchar_t>] link:#fmt-join-0a0[join]( Range&& range, link:#fmt-wstring_view[wstring_view] sep); ---- [.small]#link:#fmt-join-0a0[_» more..._]# Returns a view that formats the iterator range `[begin, end)` with elements separated by `sep`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename It, typename Sentinel> link:#fmt-join_view[join_view<It, Sentinel>] link:#fmt-join-02[join]( It begin, Sentinel end, link:#fmt-string_view[string_view] sep); ---- [.small]#link:#fmt-join-02[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename It, typename Sentinel> link:#fmt-join_view[join_view<It, Sentinel, wchar_t>] link:#fmt-join-00[join]( It begin, Sentinel end, link:#fmt-wstring_view[wstring_view] sep); ---- [.small]#link:#fmt-join-00[_» more..._]# Returns an object that formats `std::initializer_list` with elements separated by `sep`. == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-join_view[join_view<T const*, T const*>] join( std::initializer_list<T> list, link:#fmt-string_view[string_view] sep); ---- == Description *Example*: fmt::print("{}", fmt::join({1, 2, 3}, ", ")); // Output: "1, 2, 3" == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> link:#fmt-join_view[join_view<T const*, T const*, wchar_t>] join( std::initializer_list<T> list, link:#fmt-wstring_view[wstring_view] sep); ---- Returns an object that formats `std::tuple` with elements separated by `sep`. == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Tuple> constexpr link:#fmt-tuple_join_view[tuple_join_view<Tuple, char>] join( Tuple const& tuple, link:#fmt-string_view[string_view] sep); ---- == Description *Example*: auto t = std::tuple<int, char>(1, 'a'); fmt::print("{}", fmt::join(t, ", ")); // Output: 1, a == Return Value an object that formats `std::tuple` with elements separated by `sep`. == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Tuple> link:#fmt-tuple_join_view[tuple_join_view<Tuple, wchar_t>] join( Tuple const& tuple, link:#fmt-basic_string_view[basic_string_view<wchar_t>] sep); ---- Returns a view that formats `range` with elements separated by `sep`. == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Range> link:#fmt-join_view[join_view<decltype(detail::range_begin(r)), decltype(detail::range_end(r))>] join( Range&& r, link:#fmt-string_view[string_view] sep); ---- == Description *Example*: auto v = std::vector<int>{1, 2, 3}; fmt::print("{}", fmt::join(v, ", ")); // Output: 1, 2, 3 `fmt::join` applies passed format specifiers to the range elements: fmt::print("{:02}", fmt::join(v, ", ")); // Output: 01, 02, 03 == Return Value a view that formats `range` with elements separated by `sep`. == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Range> link:#fmt-join_view[join_view<decltype(std::begin(range)), decltype(std::end(range)), wchar_t>] join( Range&& range, link:#fmt-wstring_view[wstring_view] sep); ---- Returns a view that formats the iterator range `[begin, end)` with elements separated by `sep`. == Synopsis Declared in `<fmt/ranges.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename It, typename Sentinel> link:#fmt-join_view[join_view<It, Sentinel>] join( It begin, Sentinel end, link:#fmt-string_view[string_view] sep); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename It, typename Sentinel> link:#fmt-join_view[join_view<It, Sentinel, wchar_t>] join( It begin, Sentinel end, link:#fmt-wstring_view[wstring_view] sep); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Context = link:#fmt-context[context], typename... T, int NUM_ARGS = sizeof...(T), int NUM_NAMED_ARGS = detail::count_named_args<T...>(), unsigned long long DESC = detail::make_descriptor<Context, T...>()> [[always_inline]] constexpr /* implementation-defined */ make_format_args(T...&... args); ---- Constructs an `format_arg_store` object that contains references to arguments and can be implicitly converted to `printf_args`. == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename Char = char, typename... T> decltype(fmt::make_format_args<basic_printf_context<Char>>(args...)) make_printf_args(T...&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> constexpr decltype(fmt::make_format_args<wformat_context>(args...)) make_wformat_args(T...&... args); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> constexpr T max_of( T a, T b); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> constexpr T min_of( T a, T b); ---- Bitwise disjunction operators == Synopses Declared in `<fmt/color.h>` Bitwise disjunction operator [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style] link:#fmt-operator_bitor-06[operator|]( link:#fmt-emphasis[emphasis] lhs, link:#fmt-emphasis[emphasis] rhs) noexcept; ---- [.small]#link:#fmt-operator_bitor-06[_» more..._]# Bitwise disjunction operator [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style] link:#fmt-operator_bitor-00[operator|]( link:#fmt-text_style[text_style] lhs, link:#fmt-text_style[text_style] rhs); ---- [.small]#link:#fmt-operator_bitor-00[_» more..._]# Bitwise disjunction operator == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style] operator|( link:#fmt-emphasis[emphasis] lhs, link:#fmt-emphasis[emphasis] rhs) noexcept; ---- == Return Value A text style consisting of foreground and background colors and emphasis. == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== Bitwise disjunction operator == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr link:#fmt-text_style[text_style] operator|( link:#fmt-text_style[text_style] lhs, link:#fmt-text_style[text_style] rhs); ---- == Return Value A text style consisting of foreground and background colors and emphasis. == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== `print` overloads == Synopses Declared in `<fmt/base.h>` Formats `args` according to specifications in `fmt` and writes the output to `stdout`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void link:#fmt-print-03[print]( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-03[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-print-07[print]( link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-07[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> void link:#fmt-print-017[print]( S const& fmt, T...&&... args); ---- [.small]#link:#fmt-print-017[_» more..._]# Formats a string and prints it to stdout using ANSI escape sequences to specify text formatting. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-print-0c[print]( link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-0c[_» more..._]# Prints formatted data to the stream `os`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-print-0a[print]( std::ostream& os, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-0a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-print-05[print]( std::wostream& os, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-05[_» more..._]# Formats `args` according to specifications in `fmt` and writes the output to the file `f`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void link:#fmt-print-00[print]( FILE* f, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-00[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-print-0e[print]( FILE* f, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-0e[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> void link:#fmt-print-09[print]( FILE* f, S const& fmt, T...&&... args); ---- [.small]#link:#fmt-print-09[_» more..._]# Formats a string and prints it to the specified file stream using ANSI escape sequences to specify text formatting. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-print-01a[print]( FILE* f, link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-print-01a[_» more..._]# Formats `args` according to specifications in `fmt` and writes the output to `stdout`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void print( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: fmt::print("The answer is {}.", 42); == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> void print( S const& fmt, T...&&... args); ---- Formats a string and prints it to stdout using ANSI escape sequences to specify text formatting. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: fmt::print(fmt::emphasis::bold | fg(fmt::color::red), "Elapsed time: {0:.2f} seconds", 1.23); == Parameters [cols=2] |=== | Name | Description | *ts* | A text style consisting of foreground and background colors and emphasis. |=== Prints formatted data to the stream `os`. == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( std::ostream& os, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: fmt::print(cerr, "Don't {}!", "panic"); == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( std::wostream& os, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- Formats `args` according to specifications in `fmt` and writes the output to the file `f`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void print( FILE* f, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: fmt::print(stderr, "Don't {}!", "panic"); == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( FILE* f, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/compile.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename... T> void print( FILE* f, S const& fmt, T...&&... args); ---- Formats a string and prints it to the specified file stream using ANSI escape sequences to specify text formatting. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void print( FILE* f, link:#fmt-text_style[text_style] ts, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: fmt::print(fmt::emphasis::bold | fg(fmt::color::red), "Elapsed time: {0:.2f} seconds", 1.23); == Parameters [cols=2] |=== | Name | Description | *ts* | A text style consisting of foreground and background colors and emphasis. |=== Formats `args` according to specifications in `fmt` and writes the output to `stdout`. == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> int printf( link:#fmt-string_view[string_view] fmt, T const...&... args); ---- == Description *Example*: fmt::printf("Elapsed time: %.2f seconds", 1.23); `println` overloads == Synopses Declared in `<fmt/base.h>` Formats `args` according to specifications in `fmt` and writes the output to `stdout` followed by a newline. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void link:#fmt-println-04de[println]( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-println-04de[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-println-0f[println]( link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-println-0f[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-println-02[println]( std::ostream& os, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-println-02[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-println-05[println]( std::wostream& os, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-println-05[_» more..._]# Formats `args` according to specifications in `fmt` and writes the output to the file `f` followed by a newline. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void link:#fmt-println-04db[println]( FILE* f, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-println-04db[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void link:#fmt-println-04b[println]( FILE* f, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- [.small]#link:#fmt-println-04b[_» more..._]# Formats `args` according to specifications in `fmt` and writes the output to `stdout` followed by a newline. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void println( link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void println( link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void println( std::ostream& os, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void println( std::wostream& os, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- Formats `args` according to specifications in `fmt` and writes the output to the file `f` followed by a newline. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[always_inline]] void println( FILE* f, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> void println( FILE* f, link:#fmt-wformat_string[wformat_string<T...>] fmt, T...&&... args); ---- Converts `p` to `const void*` for pointer formatting. == Synopses Declared in `<fmt/format.h>` Converts `p` to `const void*` for pointer formatting. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void const* link:#fmt-ptr-01[ptr](T p); ---- [.small]#link:#fmt-ptr-01[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void const* link:#fmt-ptr-04[ptr](std::shared_ptr<T> const& p); ---- [.small]#link:#fmt-ptr-04[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Deleter> void const* link:#fmt-ptr-0f[ptr](std::unique_ptr<T, Deleter> const& p); ---- [.small]#link:#fmt-ptr-0f[_» more..._]# Converts `p` to `const void*` for pointer formatting. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void const* ptr(T p); ---- == Description *Example*: auto s = fmt::format("{}", fmt::ptr(p)); == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> void const* ptr(std::shared_ptr<T> const& p); ---- == Synopsis Declared in `<fmt/std.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Deleter> void const* ptr(std::unique_ptr<T, Deleter> const& p); ---- Reports a format error at compile time or, via a `format_error` exception, at runtime. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- [[noreturn]] void report_error(char const* message); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void report_system_error( int error_code, char const* message) noexcept; ---- Creates a runtime format string. == Synopses Declared in `<fmt/base.h>` Creates a runtime format string. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-runtime_format_string[runtime_format_string] link:#fmt-runtime-0a[runtime](link:#fmt-string_view[string_view] s); ---- [.small]#link:#fmt-runtime-0a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-runtime_format_string[runtime_format_string<wchar_t>] link:#fmt-runtime-06[runtime](link:#fmt-wstring_view[wstring_view] s); ---- [.small]#link:#fmt-runtime-06[_» more..._]# Creates a runtime format string. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-runtime_format_string[runtime_format_string] runtime(link:#fmt-string_view[string_view] s); ---- == Description *Example*: // Check format string at runtime instead of compile‐time. fmt::print(fmt::runtime("{:d}"), "I am not a number"); == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- link:#fmt-runtime_format_string[runtime_format_string<wchar_t>] runtime(link:#fmt-wstring_view[wstring_view] s); ---- Formats `args` according to specifications in `fmt` and returns the result as as string. == Synopses Declared in `<fmt/printf.h>` Formats `args` according to specifications in `fmt` and returns the result as as string. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::string link:#fmt-sprintf-0a[sprintf]( link:#fmt-string_view[string_view] fmt, T const...&... args); ---- [.small]#link:#fmt-sprintf-0a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[deprecated]] std::wstring link:#fmt-sprintf-0b[sprintf]( link:#fmt-basic_string_view[basic_string_view<wchar_t>] fmt, T const...&... args); ---- [.small]#link:#fmt-sprintf-0b[_» more..._]# Formats `args` according to specifications in `fmt` and returns the result as as string. == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::string sprintf( link:#fmt-string_view[string_view] fmt, T const...&... args); ---- == Description *Example*: std::string message = fmt::sprintf("The answer is %d", 42); == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> [[deprecated]] std::wstring sprintf( link:#fmt-basic_string_view[basic_string_view<wchar_t>] fmt, T const...&... args); ---- Returns a view that formats `value` via an ostream `operator<<`. == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> constexpr /* implementation-defined */ streamed(T const& value); ---- == Description *Example*: fmt::print("Current thread id: {}n", fmt::streamed(std::this_thread::get_id())); == Return Value a view that formats `value` via an ostream `operator<<`. Returns an argument that will be formatted using ANSI escape sequences, to be used in a formatting function. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> constexpr /* implementation-defined */ styled( T const& value, link:#fmt-text_style[text_style] ts); ---- == Description *Example*: fmt::print("Elapsed time: {0:.2f} seconds", fmt::styled(1.23, fmt::fg(fmt::color::green) | fmt::bg(fmt::color::blue))); == Parameters [cols=2] |=== | Name | Description | *ts* | A text style consisting of foreground and background colors and emphasis. |=== == Synopsis Declared in `<fmt/os.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::error_category const& system_category() noexcept; ---- Constructs `std::system_error` with a message formatted with `fmt::format(fmt, args...)`. `error_code` is a system error code as given by `errno`. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename... T> std::system_error system_error( int error_code, link:#fmt-format_string[format_string<T...>] fmt, T...&&... args); ---- == Description *Example*: // This throws std::system_error with the description // cannot open file 'madeup': No such file or directory // or similar (system message may vary). const char* filename = "madeup"; FILE* file = fopen(filename, "r"); if (!file) throw fmt::system_error(errno, "cannot open file '{}'", filename); Converts `value` to `std::string` using the default format for type `T`. == Synopses Declared in `<fmt/format.h>` Converts `value` to `std::string` using the default format for type `T`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> [[nodiscard]] constexpr std::string link:#fmt-to_string-034[to_string](T value); ---- [.small]#link:#fmt-to_string-034[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> [[nodiscard]] constexpr std::string link:#fmt-to_string-030[to_string](T const& value); ---- [.small]#link:#fmt-to_string-030[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> [[nodiscard]] constexpr std::string link:#fmt-to_string-01[to_string](T const& value); ---- [.small]#link:#fmt-to_string-01[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t SIZE> [[nodiscard]] std::string link:#fmt-to_string-0ba[to_string](link:#fmt-basic_memory_buffer[basic_memory_buffer<char, SIZE>] const& buf); ---- [.small]#link:#fmt-to_string-0ba[_» more..._]# Converts `value` to `std::string` using the default format for type `T`. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> [[nodiscard]] constexpr std::string to_string(T value); ---- == Description *Example*: std::string answer = fmt::to_string(42); == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> [[nodiscard]] constexpr std::string to_string(T const& value); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> [[nodiscard]] constexpr std::string to_string(T const& value); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t SIZE> [[nodiscard]] std::string to_string(link:#fmt-basic_memory_buffer[basic_memory_buffer<char, SIZE>] const& buf); ---- Converts `value` to `std::wstring` using the default format for type `T`. == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename T> std::wstring to_wstring(T const& value); ---- Converts `e` to the underlying type. == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Enum> constexpr link:#fmt-underlying_t[underlying_t<Enum>] underlying(Enum e) noexcept; ---- == Description *Example*: enum class color { red, green, blue }; auto s = fmt::format("{}", fmt::underlying(color::red)); // s == "0" == Synopses Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string link:#fmt-vformat-083[vformat]( link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat-083[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> std::basic_string<Char> link:#fmt-vformat-088[vformat]( link:#fmt-basic_string_view[basic_string_view<Char>] fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- [.small]#link:#fmt-vformat-088[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string link:#fmt-vformat-0b[vformat]( link:#fmt-locale_ref[locale_ref] loc, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat-0b[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string link:#fmt-vformat-05[vformat]( link:#fmt-text_style[text_style] ts, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat-05[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::wstring link:#fmt-vformat-06[vformat]( link:#fmt-text_style[text_style] ts, link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- [.small]#link:#fmt-vformat-06[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename Char = /* implementation-defined */> std::basic_string<Char> link:#fmt-vformat-07[vformat]( link:#fmt-locale_ref[locale_ref] loc, S const& fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- [.small]#link:#fmt-vformat-07[_» more..._]# == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string vformat( link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> std::basic_string<Char> vformat( link:#fmt-basic_string_view[basic_string_view<Char>] fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string vformat( link:#fmt-locale_ref[locale_ref] loc, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::string vformat( link:#fmt-text_style[text_style] ts, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::wstring vformat( link:#fmt-text_style[text_style] ts, link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename Char = /* implementation-defined */> std::basic_string<Char> vformat( link:#fmt-locale_ref[locale_ref] loc, S const& fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- `vformat_to` overloads == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t N> link:#fmt-format_to_result[format_to_result] link:#fmt-vformat_to-07[vformat_to]( char(& out)[], link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat_to-07[_» more..._]# Formats a string and writes the output to `out`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> link:#fmt-remove_cvref_t[remove_cvref_t<OutputIt>] link:#fmt-vformat_to-0f[vformat_to]( OutputIt&& out, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat_to-0f[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename Char = /* implementation-defined */> OutputIt link:#fmt-vformat_to-01[vformat_to]( OutputIt out, S const& fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- [.small]#link:#fmt-vformat_to-01[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> OutputIt link:#fmt-vformat_to-098[vformat_to]( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat_to-098[_» more..._]# Formats a string with the given text_style and writes the output to `out`. [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> OutputIt link:#fmt-vformat_to-08[vformat_to]( OutputIt out, link:#fmt-text_style[text_style] ts, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat_to-08[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename OutputIt, typename... Args, typename Char = /* implementation-defined */> OutputIt link:#fmt-vformat_to-090[vformat_to]( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, S const& fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- [.small]#link:#fmt-vformat_to-090[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<size_t N> link:#fmt-format_to_result[format_to_result] vformat_to( char(& out)[], link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- Formats a string and writes the output to `out`. == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> link:#fmt-remove_cvref_t[remove_cvref_t<OutputIt>] vformat_to( OutputIt&& out, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename S, typename Char = /* implementation-defined */> OutputIt vformat_to( OutputIt out, S const& fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> OutputIt vformat_to( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- Formats a string with the given text_style and writes the output to `out`. == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename OutputIt> OutputIt vformat_to( OutputIt out, link:#fmt-text_style[text_style] ts, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Parameters [cols=2] |=== | Name | Description | *ts* | A text style consisting of foreground and background colors and emphasis. |=== == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename S, typename OutputIt, typename... Args, typename Char = /* implementation-defined */> OutputIt vformat_to( OutputIt out, link:#fmt-locale_ref[locale_ref] loc, S const& fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] link:#fmt-vformat_to_n-0a[vformat_to_n]( OutputIt out, size_t n, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vformat_to_n-0a[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename Char, typename... Args> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] link:#fmt-vformat_to_n-0f[vformat_to_n]( OutputIt out, size_t n, link:#fmt-basic_string_view[basic_string_view<Char>] fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- [.small]#link:#fmt-vformat_to_n-0f[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename... T> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] vformat_to_n( OutputIt out, size_t n, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename OutputIt, typename Char, typename... Args> link:#fmt-format_to_n_result[format_to_n_result<OutputIt>] vformat_to_n( OutputIt out, size_t n, link:#fmt-basic_string_view[basic_string_view<Char>] fmt, link:#fmt-basic_format_args[basic_format_args<buffered_context<Char>>] args); ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> int vfprintf( FILE* f, link:#fmt-basic_string_view[basic_string_view<Char>] fmt, vprintf_args<Char>::type args); ---- == Synopses Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-03[vprint]( link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vprint-03[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-04[vprint]( link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- [.small]#link:#fmt-vprint-04[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-0e[vprint]( std::ostream& os, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vprint-0e[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-01[vprint]( std::wostream& os, link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- [.small]#link:#fmt-vprint-01[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-00f[vprint]( FILE* f, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vprint-00f[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-07[vprint]( FILE* f, link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- [.small]#link:#fmt-vprint-07[_» more..._]# [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void link:#fmt-vprint-06[vprint]( FILE* f, link:#fmt-text_style[text_style] ts, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- [.small]#link:#fmt-vprint-06[_» more..._]# == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- == Synopsis Declared in `<fmt/ostream.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( std::ostream& os, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( std::wostream& os, link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( FILE* f, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/xchar.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( FILE* f, link:#fmt-wstring_view[wstring_view] fmt, link:#fmt-wformat_args[wformat_args] args); ---- == Synopsis Declared in `<fmt/color.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint( FILE* f, link:#fmt-text_style[text_style] ts, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprint_buffered( FILE* f, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- void vprintln( FILE* f, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- == Synopsis Declared in `<fmt/printf.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template<typename Char> std::basic_string<Char> vsprintf( link:#fmt-basic_string_view[basic_string_view<Char>] fmt, vprintf_args<Char>::type args); ---- == Synopsis Declared in `<fmt/format.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- std::system_error vsystem_error( int error_code, link:#fmt-string_view[string_view] fmt, link:#fmt-format_args[format_args] args); ---- Equality operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- constexpr bool operator==( link:#fmt-basic_string_view[basic_string_view] lhs, link:#fmt-basic_string_view[basic_string_view] rhs); ---- == Return Value `true` if the objects are equal, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== Inequality operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool operator!=( link:#fmt-basic_string_view[basic_string_view] lhs, link:#fmt-basic_string_view[basic_string_view] rhs); ---- == Return Value `true` if the objects are not equal, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== Less‐than operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool operator<( link:#fmt-basic_string_view[basic_string_view] lhs, link:#fmt-basic_string_view[basic_string_view] rhs); ---- == Return Value `true` if the left object is less than the right object, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== Less‐than‐or‐equal operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool operator<=( link:#fmt-basic_string_view[basic_string_view] lhs, link:#fmt-basic_string_view[basic_string_view] rhs); ---- == Return Value `true` if the left object is less than or equal to the right object, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== Greater‐than operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool operator>( link:#fmt-basic_string_view[basic_string_view] lhs, link:#fmt-basic_string_view[basic_string_view] rhs); ---- == Return Value `true` if the left object is greater than the right object, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== Greater‐than‐or‐equal operator == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- bool operator>=( link:#fmt-basic_string_view[basic_string_view] lhs, link:#fmt-basic_string_view[basic_string_view] rhs); ---- == Return Value `true` if the left object is greater than or equal to the right object, `false` otherwise == Parameters [cols=2] |=== | Name | Description | *lhs* | The left operand | *rhs* | The right operand |=== == Synopsis Declared in `<fmt/base.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- template< typename T, typename Char = char> concept formattable = is_formattable<remove_reference_t<T>, Char>::value; ---- [.small]#Created with https://www.mrdocs.com[MrDocs]#