[#index] = Global namespace :relfileprefix: :mrdocs: == Namespaces [cols=1] |=== | Name | xref:fmt.adoc[`fmt`] |=== == xref:fmt.adoc[fmt] namespace === Namespaces [cols=1] |=== | Name | xref:fmt/enums.adoc[`enums`] | xref:fmt/safe_duration_cast.adoc[`safe_duration_cast`] |=== === Types [cols=2] |=== | Name | Description | xref:fmt/basic_appender.adoc[`basic_appender`] | | xref:fmt/basic_cstring_view.adoc[`basic_cstring_view`] | A reference to a null‐terminated string. It can be constructed from a C string or `std::string`. | xref:fmt/basic_format_arg.adoc[`basic_format_arg`] | | xref:fmt/basic_format_args.adoc[`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`: | xref:fmt/basic_fstring.adoc[`basic_fstring`] | | xref:fmt/basic_memory_buffer.adoc[`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`. | xref:fmt/basic_ostream_formatter.adoc[`basic_ostream_formatter`] | | xref:fmt/basic_printf_context.adoc[`basic_printf_context`] | | xref:fmt/basic_specs.adoc[`basic_specs`] | | xref:fmt/basic_string_view.adoc[`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). | xref:fmt/buffered_file.adoc[`buffered_file`] | | xref:fmt/bytes.adoc[`bytes`] | | xref:fmt/compiled_string.adoc[`compiled_string`] | | xref:fmt/conjunction-0e.adoc[`conjunction`] | | xref:fmt/conjunction-05.adoc[`conjunction<P>`] | | xref:fmt/conjunction-01.adoc[`conjunction<P1, Pn...>`] | | xref:fmt/context.adoc[`context`] | | xref:fmt/day.adoc[`day`] | | xref:fmt/dynamic_format_arg_store.adoc[`dynamic_format_arg_store`] | A dynamic list of formatting arguments with storage. | xref:fmt/file.adoc[`file`] | | xref:fmt/format_error.adoc[`format_error`] | An error reported from a formatting function. | xref:fmt/format_facet-0e.adoc[`format_facet`] | | xref:fmt/format_facet-08.adoc[`format_facet<locale>`] | | xref:fmt/format_int.adoc[`format_int`] | A fast integer formatter. | xref:fmt/format_specs.adoc[`format_specs`] | | xref:fmt/format_to_n_result.adoc[`format_to_n_result`] | | xref:fmt/format_to_result.adoc[`format_to_result`] | | xref:fmt/formatter-059.adoc[`formatter`] | | xref:fmt/formatter-0a8.adoc[`formatter</* implementation-defined */>`] | | xref:fmt/formatter-019.adoc[`formatter<bytes>`] | | xref:fmt/formatter-0a6.adoc[`formatter<std::error_code>`] | | xref:fmt/formatter-09e.adoc[`formatter<std::source_location>`] | | xref:fmt/formatter-0a3.adoc[`formatter<std::type_info>`] | | xref:fmt/formatter-01c.adoc[`formatter<group_digits_view<T>>`] | | xref:fmt/formatter-0e4.adoc[`formatter<T, char>`] | | xref:fmt/formatter-042.adoc[`formatter<std::atomic_flag, Char>`] | | xref:fmt/formatter-03f.adoc[`formatter<std::byte, Char>`] | | xref:fmt/formatter-031.adoc[`formatter<day, Char>`] | | xref:fmt/formatter-0b92.adoc[`formatter</* implementation-defined */, Char>`] | | xref:fmt/formatter-0b3.adoc[`formatter<std::thread::id, Char>`] | | xref:fmt/formatter-08b.adoc[`formatter<std::monostate, Char>`] | | xref:fmt/formatter-0c4.adoc[`formatter<month, Char>`] | | xref:fmt/formatter-070.adoc[`formatter<std::nullptr_t, Char>`] | | xref:fmt/formatter-0dd.adoc[`formatter<std::filesystem::path, Char>`] | | xref:fmt/formatter-008.adoc[`formatter<tm, Char>`] | | xref:fmt/formatter-040.adoc[`formatter<weekday, Char>`] | | xref:fmt/formatter-0e52.adoc[`formatter<year, Char>`] | | xref:fmt/formatter-07e.adoc[`formatter<year_month_day, Char>`] | | xref:fmt/formatter-0a5.adoc[`formatter</* implementation-defined */, Char>`] | | xref:fmt/formatter-026.adoc[`formatter<signed char, Char>`] | | xref:fmt/formatter-0b0.adoc[`formatter<unsigned char, Char>`] | | xref:fmt/formatter-079.adoc[`formatter<short, Char>`] | | xref:fmt/formatter-0e3f.adoc[`formatter<unsigned short, Char>`] | | xref:fmt/formatter-0b9d.adoc[`formatter<long, Char>`] | | xref:fmt/formatter-0c8.adoc[`formatter<unsigned long, Char>`] | | xref:fmt/formatter-083.adoc[`formatter<Char*, Char>`] | | xref:fmt/formatter-001.adoc[`formatter<void*, Char>`] | | xref:fmt/formatter-027.adoc[`formatter<BitRef, Char>`] | | xref:fmt/formatter-06b.adoc[`formatter<R, Char>`] | | xref:fmt/formatter-012.adoc[`formatter<R, Char>`] | | xref:fmt/formatter-06cd.adoc[`formatter<R, Char>`] | | xref:fmt/formatter-0a0.adoc[`formatter<T, Char>`] | | xref:fmt/formatter-033.adoc[`formatter<T, Char>`] | | xref:fmt/formatter-0c3.adoc[`formatter<Tuple, Char>`] | | xref:fmt/formatter-0e37.adoc[`formatter<Variant, Char>`] | | xref:fmt/formatter-0d28.adoc[`formatter<std::atomic<T>, Char>`] | | xref:fmt/formatter-06cb.adoc[`formatter<std::bitset<N>, Char>`] | | xref:fmt/formatter-0be.adoc[`formatter<std::complex<T>, Char>`] | | xref:fmt/formatter-095.adoc[`formatter<local_time<Duration>, Char>`] | | xref:fmt/formatter-05a.adoc[`formatter<nested_view<T, Char>, Char>`] | | xref:fmt/formatter-02c.adoc[`formatter<std::optional<T>, Char>`] | | xref:fmt/formatter-048.adoc[`formatter<std::reference_wrapper<T>, Char>`] | | xref:fmt/formatter-0b8.adoc[`formatter</* implementation-defined */, Char>`] | | xref:fmt/formatter-0c5.adoc[`formatter</* implementation-defined */, Char>`] | | xref:fmt/formatter-044.adoc[`formatter<sys_time<Duration>, Char>`] | | xref:fmt/formatter-0ea.adoc[`formatter<tuple_join_view<Tuple, Char>, Char>`] | | xref:fmt/formatter-060.adoc[`formatter</* implementation-defined */, Char>`] | | xref:fmt/formatter-043.adoc[`formatter<utc_time<Duration>, Char>`] | | xref:fmt/formatter-0de.adoc[`formatter<Char[], Char>`] | | xref:fmt/formatter-0e50.adoc[`formatter<std::basic_string<Char, Traits, Allocator>, Char>`] | | xref:fmt/formatter-032.adoc[`formatter<std::chrono::duration<Rep, Period>, Char>`] | | xref:fmt/formatter-0a7.adoc[`formatter<std::expected<T, E>, Char>`] | | xref:fmt/formatter-0d26.adoc[`formatter<join_view<It, Sentinel, Char>, Char>`] | | xref:fmt/formatter-000.adoc[`formatter<T, Char, void_t</* implementation-defined */>>`] | | xref:fmt/fstring.adoc[`fstring`] | A compile‐time format string. Use `format_string` in the public API to prevent type deduction. | xref:fmt/generic_context.adoc[`generic_context`] | | xref:fmt/group_digits_view.adoc[`group_digits_view`] | | xref:fmt/is_compiled_string.adoc[`is_compiled_string`] | | xref:fmt/is_contiguous-0e.adoc[`is_contiguous`] | | xref:fmt/is_contiguous-07.adoc[`is_contiguous<basic_memory_buffer<T, SIZE, Allocator>>`] | | xref:fmt/is_contiguous-03.adoc[`is_contiguous<std::basic_string<Char, Traits, Allocator>>`] | | xref:fmt/is_range.adoc[`is_range`] | | xref:fmt/is_tuple_formattable.adoc[`is_tuple_formattable`] | | xref:fmt/is_tuple_like.adoc[`is_tuple_like`] | | xref:fmt/is_variant_like.adoc[`is_variant_like`] | | xref:fmt/join_view.adoc[`join_view`] | | xref:fmt/loc_value.adoc[`loc_value`] | | xref:fmt/locale_ref.adoc[`locale_ref`] | | xref:fmt/monostate.adoc[`monostate`] | | xref:fmt/month.adoc[`month`] | | xref:fmt/nested_formatter.adoc[`nested_formatter`] | | xref:fmt/nested_view.adoc[`nested_view`] | | xref:fmt/parse_context-05.adoc[`parse_context`] | Parsing context consisting of a format string range being parsed and an argument counter for automatic indexing. | xref:fmt/parse_context-01.adoc[`parse_context<char>`] | | xref:fmt/path.adoc[`path`] | | xref:fmt/range_format_kind.adoc[`range_format_kind`] | | xref:fmt/range_formatter-0e.adoc[`range_formatter`] | | xref:fmt/range_formatter-05.adoc[`range_formatter<T, Char>`] | | xref:fmt/rgb.adoc[`rgb`] | | xref:fmt/runtime_format_string.adoc[`runtime_format_string`] | | xref:fmt/static_format_result.adoc[`static_format_result`] | | xref:fmt/string_buffer.adoc[`string_buffer`] | | xref:fmt/text_style.adoc[`text_style`] | A text style consisting of foreground and background colors and emphasis. | xref:fmt/tuple_join_view.adoc[`tuple_join_view`] | | xref:fmt/vprintf_args.adoc[`vprintf_args`] | | xref:fmt/weekday.adoc[`weekday`] | | xref:fmt/writer.adoc[`writer`] | | xref:fmt/year.adoc[`year`] | | xref:fmt/year_month_day.adoc[`year_month_day`] | | xref:fmt/appender.adoc[`appender`] | | xref:fmt/basic_format_context.adoc[`basic_format_context`] | | xref:fmt/basic_format_parse_context.adoc[`basic_format_parse_context`] | | xref:fmt/basic_format_string.adoc[`basic_format_string`] | | xref:fmt/bool_constant.adoc[`bool_constant`] | | xref:fmt/buffered_context.adoc[`buffered_context`] | | xref:fmt/conditional_t.adoc[`conditional_t`] | | xref:fmt/cstring_view.adoc[`cstring_view`] | | xref:fmt/decay_t.adoc[`decay_t`] | | xref:fmt/enable_if_t.adoc[`enable_if_t`] | | xref:fmt/format_args.adoc[`format_args`] | | xref:fmt/format_context.adoc[`format_context`] | | xref:fmt/format_parse_context.adoc[`format_parse_context`] | | xref:fmt/format_string.adoc[`format_string`] | | xref:fmt/is_formattable.adoc[`is_formattable`] | | xref:fmt/local_time.adoc[`local_time`] | | xref:fmt/make_unsigned_t.adoc[`make_unsigned_t`] | | xref:fmt/memory_buffer.adoc[`memory_buffer`] | | xref:fmt/nullptr_t.adoc[`nullptr_t`] | | xref:fmt/ostream_formatter.adoc[`ostream_formatter`] | | xref:fmt/printf_args.adoc[`printf_args`] | | xref:fmt/printf_context.adoc[`printf_context`] | | xref:fmt/remove_const_t.adoc[`remove_const_t`] | | xref:fmt/remove_cvref_t.adoc[`remove_cvref_t`] | | xref:fmt/remove_reference_t.adoc[`remove_reference_t`] | | xref:fmt/string_view.adoc[`string_view`] | | xref:fmt/sys_time.adoc[`sys_time`] | | xref:fmt/underlying_t.adoc[`underlying_t`] | | xref:fmt/utc_time.adoc[`utc_time`] | | xref:fmt/vargs.adoc[`vargs`] | | xref:fmt/void_t.adoc[`void_t`] | | xref:fmt/wcstring_view.adoc[`wcstring_view`] | | xref:fmt/wformat_args.adoc[`wformat_args`] | | xref:fmt/wformat_context.adoc[`wformat_context`] | | xref:fmt/wformat_parse_context.adoc[`wformat_parse_context`] | | xref:fmt/wformat_string.adoc[`wformat_string`] | | xref:fmt/wmemory_buffer.adoc[`wmemory_buffer`] | | xref:fmt/wprintf_args.adoc[`wprintf_args`] | | xref:fmt/wprintf_context.adoc[`wprintf_context`] | | xref:fmt/wstring_view.adoc[`wstring_view`] | |=== === Enums [cols=1] |=== | Name | xref:fmt/_04enum.adoc[`Unnamed enum`] | xref:fmt/align.adoc[`align`] | xref:fmt/arg_id_kind.adoc[`arg_id_kind`] | xref:fmt/color.adoc[`color`] | xref:fmt/emphasis.adoc[`emphasis`] | xref:fmt/presentation_type.adoc[`presentation_type`] | xref:fmt/range_format.adoc[`range_format`] | xref:fmt/sign.adoc[`sign`] | xref:fmt/terminal_color.adoc[`terminal_color`] |=== === Functions [cols=2] |=== | Name | Description | xref:fmt/2function-0a.adoc[`Unnamed overloads`] | | xref:fmt/arg.adoc[`arg`] | Returns a named argument to be used in a formatting function. It should only be used in a call to a formatting function. | xref:fmt/assert_fail.adoc[`assert_fail`] | | xref:fmt/bg.adoc[`bg`] | Creates a text style from the background color. | xref:fmt/fg.adoc[`fg`] | Creates a text style from the foreground (text) color. | xref:fmt/format-02.adoc[`format`] | `format` overloads | xref:fmt/format_system_error.adoc[`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: | xref:fmt/format_to-0da.adoc[`format_to`] | `format_to` overloads | xref:fmt/format_to_n-0b.adoc[`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. | xref:fmt/formatted_size-0e2.adoc[`formatted_size`] | Returns the number of chars in the output of `format(fmt, args...)`. | xref:fmt/fprintf-0b.adoc[`fprintf`] | Formats `args` according to specifications in `fmt` and writes the output to `f`. | xref:fmt/gmtime-03d.adoc[`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. | xref:fmt/group_digits.adoc[`group_digits`] | Returns a view that formats an integer value using ',' as a locale‐independent thousands separator. | xref:fmt/join-03.adoc[`join`] | `join` overloads | xref:fmt/make_format_args.adoc[`make_format_args`] | | xref:fmt/make_printf_args.adoc[`make_printf_args`] | Constructs an `format_arg_store` object that contains references to arguments and can be implicitly converted to `printf_args`. | xref:fmt/make_wformat_args.adoc[`make_wformat_args`] | | xref:fmt/max_of.adoc[`max_of`] | | xref:fmt/min_of.adoc[`min_of`] | | xref:fmt/operator_bitor-08.adoc[`operator|`] | Bitwise disjunction operators | xref:fmt/print-02c.adoc[`print`] | `print` overloads | xref:fmt/printf.adoc[`printf`] | Formats `args` according to specifications in `fmt` and writes the output to `stdout`. | xref:fmt/println-0d.adoc[`println`] | `println` overloads | xref:fmt/ptr-06.adoc[`ptr`] | Converts `p` to `const void` for pointer formatting. | xref:fmt/report_error.adoc[`report_error`] | Reports a format error at compile time or, via a `format_error` exception, at runtime. | xref:fmt/report_system_error.adoc[`report_system_error`] | | xref:fmt/runtime-0c.adoc[`runtime`] | Creates a runtime format string. | xref:fmt/sprintf-05.adoc[`sprintf`] | Formats `args` according to specifications in `fmt` and returns the result as as string. | xref:fmt/streamed.adoc[`streamed`] | Returns a view that formats `value` via an ostream `operator<<`. | xref:fmt/styled.adoc[`styled`] | Returns an argument that will be formatted using ANSI escape sequences, to be used in a formatting function. | xref:fmt/system_category.adoc[`system_category`] | | xref:fmt/system_error.adoc[`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`. | xref:fmt/to_string-0b.adoc[`to_string`] | Converts `value` to `std::string` using the default format for type `T`. | xref:fmt/to_wstring.adoc[`to_wstring`] | Converts `value` to `std::wstring` using the default format for type `T`. | xref:fmt/underlying.adoc[`underlying`] | Converts `e` to the underlying type. | xref:fmt/vformat-02.adoc[`vformat`] | | xref:fmt/vformat_to-0b.adoc[`vformat_to`] | `vformat_to` overloads | xref:fmt/vformat_to_n-01.adoc[`vformat_to_n`] | | xref:fmt/vfprintf.adoc[`vfprintf`] | | xref:fmt/vprint-00.adoc[`vprint`] | | xref:fmt/vprint_buffered.adoc[`vprint_buffered`] | | xref:fmt/vprintln.adoc[`vprintln`] | | xref:fmt/vsprintf.adoc[`vsprintf`] | | xref:fmt/vsystem_error.adoc[`vsystem_error`] | | xref:fmt/operator_eq.adoc[`operator==`] | Equality operator | xref:fmt/operator_not_eq.adoc[`operator!=`] | Inequality operator | xref:fmt/operator_lt.adoc[`operator<`] | Less‐than operator | xref:fmt/operator_le.adoc[`operator<=`] | Less‐than‐or‐equal operator | xref:fmt/operator_gt.adoc[`operator>`] | Greater‐than operator | xref:fmt/operator_ge.adoc[`operator>=`] | Greater‐than‐or‐equal operator |=== === Concepts [cols=1] |=== | Name | xref:fmt/formattable.adoc[`formattable`] |=== == xref:fmt/enums.adoc[fmt::enums] namespace === Functions [cols=1] |=== | Name | xref:fmt/enums/format_as.adoc[`format_as`] |=== == xref:fmt/safe_duration_cast.adoc[fmt::safe_duration_cast] namespace === Functions [cols=2] |=== | Name | Description | xref:fmt/safe_duration_cast/lossless_integral_conversion-0d.adoc[`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. | xref:fmt/safe_duration_cast/safe_duration_cast.adoc[`safe_duration_cast`] | Safe duration_cast between floating point durations | xref:fmt/safe_duration_cast/safe_float_conversion-0f1.adoc[`safe_float_conversion`] | converts From to To if possible, otherwise ec is set. |=== [.small]#Created with https://www.mrdocs.com[MrDocs]#