std::range-...t-formatter(3)

📦 version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

💖 std::range-...t-formatter(3) 💖

okay so bestie, welcome to this page in the C++ Standard Libary manual (yes, the header spells it “Libary” 😭, we’re keeping it). The title up top is std::range-...t-formatter(3), and the NAME is literally std::range-default-formatter twice. Slay, let’s go. ✨

🌸 NAME 🌸

std::range-default-formatter — std::range-default-formatter. That’s the whole name, no cap: both sides match, and we move on. 💅

🦋 Synopsis 🦋

Defined in header <format>:

template< ranges::input_range R, class CharT >
(since C++23)
struct range-default-formatter<range_format::sequence, R,
(exposition only*)
CharT>;

The class template range-default-formatter for range types is specialized for formatting range as a sequence of elements if std::format_kind<R> is std::range_format::sequence. 💖

🌈 Member types 🌈

  • maybe-const-r (private) — definition: /*fmt-maybe-const*/<R, CharT>; this is an (exposition-only member type*). 🎀

🧚 Member objects 🧚

  • underlying_ (private) — the underlying formatter of type std::range_formatter<std::remove_cvref_t<ranges::range_reference_t<maybe-const-r>>, CharT>; this is an (exposition-only member object*). 🫶

👑 Member functions 👑

  • constructor (implicitly declared) — constructs a range-default-formatter; public member function. ✨
  • set_separator — sets a specified separator for the range formatted result; public member function. 💅
  • set_brackets — sets a specified opening and closing brackets for the range formatted result; public member function. 🎀
  • parse — parses the format specifier as specified by range-format-spec; public member function. 🦋
  • format — writes the range formatted output as specified by range-format-spec; public member function. 🔥

✨ std::range-default-formatter<std::range_format::sequence>::set_separator ✨

constexpr void set_separator( std::basic_string_view<CharT> sep ) noexcept;

Equivalent to a call to underlying_.set_separator(sep). 💖

🦋 std::range-default-formatter<std::range_format::sequence>::set_brackets 🦋

constexpr void set_brackets( std::basic_string_view<CharT> opening,
                             std::basic_string_view<CharT> closing )
noexcept;

Equivalent to a call to underlying_.set_brackets(opening, closing). ✨

🌸 std::range-default-formatter<std::range_format::sequence>::parse 🌸

template< class ParseContext >
constexpr auto parse( ParseContext& ctx ) -> ParseContext::iterator;

Equivalent to return underlying_.parse(ctx);.

Returns an iterator past the end of the range-format-spec. 🎀

🔥 std::range-default-formatter<std::range_format::sequence>::format 🔥

template< class FormatContext >
auto format( maybe-const-r& elems, FormatContext& ctx ) const ->
FormatContext::iterator;

Equivalent to return underlying_.format(elems, ctx);.

Returns an iterator past the end of the output range. 👑

🌈 See also 🌈

  • formatter (C++20) — defines formatting rules for a given type; class template. 💖
  • range_formatter (C++23) — class template that helps implementing std::formatter specializations for range types; class template. 🦋

okay bestie that’s the whole page — mwah 💋. Source/version and date from the footer: http://cppreference.com, 2024.06.10; page title std::range-...t-formatter(3). 🫶✨

📦 where this page comes from