最終更新日時: 2024年06月11日 22時45分38秒 (JST)
Akira Takahashi が更新

履歴 編集

function template
<expected>

# std::expected::transform_error(C++23)

    template<class F> constexpr auto transform_error(F&& f) &;        // (1)
    template<class F> constexpr auto transform_error(F&& f) const &;  // (2)
    template<class F> constexpr auto transform_error(F&& f) &&;       // (3)
    template<class F> constexpr auto transform_error(F&& f) const &&; // (4)

## 概要

エラー値を保持していれば、エラー値に対して`f`を適用した結果を`expected`のエラー値として格納して返す。 正常値を保持していれば、そのまま返す。

実際には複数オーバーロードが提供されるが、大まかには下記シグニチャのようにみなせる。 `transform_error`へは、引数リストに1個の`E`型をとり`Return`型を返す関数や関数オブジェクトを与える。

    template <class T, class E>
    class expected {
      template <class Return>
      std::expected<T, Return> transform_error(function<Return(E)> func);
    };

## テンプレートパラメータ制約

- (1), (2) : `is_copy_constructible_v<T> == true`
- (3), (4) : `is_move_constructible_v<T> == true`

## 適格要件

- (1), (2) : 型`G`を`remove_cvref_t<invoke_result_t<F, decltype(error())>>`としたとき、次を全て満たすこと
  - `G`が`expected`の有効なエラー値型である
  - 宣言`G g(invoke(std::forward<F>(f), error()));`が妥当である
- (3), (4) : 型`G`を`remove_cvref_t<invoke_result_t<F, decltype(std::move(error()))>>`としたとき、次を全て満たすこと
  - `G`が`expected`の有効なエラー値型である
  - 宣言`G g(invoke(std::forward<F>(f), std::move(error())));`が妥当である

## 効果

- (1), (2) : 次の効果をもつ
  - 正常値を保持していたら、`expected<T, G>(in_place, value())`を返す。
  - そうでなければ、エラー値を`invoke(std::forward<F>(f), error())`で直接非リスト初期化した`expected<T, G>`オブジェクトを返す。
- (3), (4) : 次の効果をもつ
  - 正常値を保持していたら、`expected<T, G>(in_place, std::move(value()))`を返す。
  - そうでなければ、エラー値を`invoke(std::forward<F>(f), std::move(error()))`で直接非リスト初期化した`expected<T, G>`オブジェクトを返す。

## 備考

`transform_error`は、メソッドチェーンをサポートするモナド風(monadic)操作として導入された。

## 例

    #include <cassert>
    #include <algorithm>
    #include <expected>
    #include <string>

    // 文字列を逆順に並べ替える関数
    std::string revstr(std::string str)
    {
      std::reverse(str.begin(), str.end());
      return str;
    }

    int main()
    {
      std::expected<int, std::string> v1 = 42;
      assert(v1.transform_error(revstr).value() == 42);

      std::expected<int, std::string> e1 = std::unexpected{"Oops"};
      assert(e1.transform_error(revstr).error() == "spoO");
    }

### 出力

## バージョン

### 言語

- C++23

### 処理系

- Clang: ??
- GCC: 13.0 ✅
- ICC: ??
- Visual C++: ??

## 関連項目

- `and_then()`
- `or_else()`
- `transform()`

## 参照

- P2505R5 Monadic Functions for `std::expected`