begin.md

begin

• format[meta header]
• function[meta id-type]
• std[meta namespace]
• basic_format_parse_context[meta class]
• cpp20[meta cpp]

constexpr const_iterator begin() const noexcept;

概要

残りの書式文字列の先頭を指すイテレータを取得する。

効果

メンバ変数として保持している、書式文字列の先頭を指すイテレータを返す。

備考

コンテキストがフォーマッターのparseメンバ関数に渡された時点で、この関数の値は以下のいずれかである。

• 置換フィールドのオプション{:options...}がある場合、:の次の文字を指すイテレータ
• オプションがない場合、 end() と等しいか、}を指すイテレータ

例

基本的な使い方

#include <iostream>
#include <format>

enum color { red, green, blue };

const char* color_names[] = { "red", "green", "blue" };

template<>
class std::formatter<color> {
  bool enable_quote = false;
public:
  constexpr auto parse(std::format_parse_context& ctx) {
    auto it = ctx.begin();
    if (it == ctx.end()) {
      return it;
    }

    if (*it == '%') {
      enable_quote = true;
      ++it;
    }
    return it;
  }

  auto format(color c, std::format_context& ctx) const {
    if (enable_quote) {
      return std::format_to(ctx.out(), "\"{}\"", color_names[c]);
    }
    else {
      return std::format_to(ctx.out(), "{}", color_names[c]);
    }
  }
};

int main()
{
  std::cout << std::format("{:%}", red) << std::endl;
}

• ctx.begin()[color ff0000]
• ctx.end()[link end.md]
• std::format[link /reference/format/format.md]
• std::format_to[link /reference/format/format_to.md]
• std::format_context[link /reference/format/basic_format_context.md]
• ctx.out()[link /reference/format/basic_format_context/out.md]

出力

"red"

バージョン

言語

• C++20

処理系

• Clang: ??
• GCC: 13 [mark verified]
• Visual C++: ??

参照

• P0645R10 Text Formatting