std::expected

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ユーティリティライブラリ

言語サポート 型のサポート (基本型、RTTI) ライブラリ機能検査マクロ (C++20) プログラムユーティリティ 可変引数関数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) コルーチンサポート (C++20) 契約サポート (C++26) 三方比較 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)   is_eqis_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

汎用ユーティリティ 関数オブジェクト ビット操作 (C++20) bitset hash (C++11) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 共通語彙型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23)

 

std::expected

メンバ関数

expected::expected

expected::~expected

expected::operator=

監視

expected::operator->expected::operator*

expected::operator boolexpected::has_value

expected::value

expected::error

expected::value_or

expected::error_or

モナド操作

expected::and_then

expected::or_else

expected::transform

expected::transform_error

変更

expected::emplace

expected::swap

非メンバ関数

operator==(std::expected)

swap(std::expected)

ヘルパークラス

unexpected

bad_expected_access

unexpect_tunexpect

 

ヘッダ <expected> で定義
template< class T, class E > class expected;	(1)	(C++23から)
template< class T, class E >     requires std::is_void_v<T> class expected<T, E>;	(2)	(C++23から)

クラステンプレート std::expected は、期待される値（T型）か、あるいは期待されない値（E型）かのいずれかを表す方法を提供します。expected が値を持たない状態になることはありません。

1) プライマリテンプレート。期待される値または期待されない値を自身のストレージ内に保持します。このストレージは expected オブジェクトの内部にネストされています。

2) void 部分特殊化。期待される void 値を表すか、期待されない値を保持します。期待されない値を保持する場合、その値は expected オブジェクトの内部にネストされます。

参照型、関数型、または std::unexpected の特殊化で expected をインスタンス化するプログラムは不適格 (ill-formed) です。加えて、T は std::in_place_t や std::unexpect_t であってはなりません。

テンプレートパラメータ

T	-	期待される値の型。型は (cv修飾された) void であるか、デストラクタ呼び出し可能 (Destructible) の要件を満たさなければなりません (特に、配列型や参照型は許可されません)。
E	-	期待されない値の型。型はデストラクタ呼び出し可能 (Destructible) の要件を満たし、std::unexpected の有効なテンプレート引数でなければなりません (特に、配列、非オブジェクト型、cv修飾された型は許可されません)。

メンバ型

メンバ型	定義
value_type	T
error_type	E
unexpected_type	std::unexpected<E>

メンバエイリアステンプレート

型	定義
rebind<U>	std::expected<U, error_type>

データメンバ

メンバ	定義
bool has_val	expected オブジェクトが現在、期待される値を表しているかどうか (説明用のメンバオブジェクト*)
T val (プライマリテンプレートのみ)	期待される値 (説明専用の variant メンバオブジェクト*)
E unex	期待されない値 (説明専用の variant メンバオブジェクト*)

メンバ関数

(コンストラクタ)	expected オブジェクトを構築する (public member function)
(デストラクタ)	expected オブジェクトと、それに含まれる値を破棄する (public member function)
operator=	内容を代入する (public member function)
監視
operator->operator*	期待される値にアクセスする (public member function)
operator boolhas_value	オブジェクトが期待される値を保持しているか確認する (public member function)
value	期待される値を返す (public member function)
error	期待されない値を返す (public member function)
value_or	期待される値が存在すればそれを返し、そうでなければ別の値を返す (public member function)
error_or	期待されない値が存在すればそれを返し、そうでなければ別の値を返す (public member function)
モナド操作
and_then	期待される値が存在する場合、その値に対して与えられた関数を実行した結果を返し、そうでなければ expected 自体を返す (public member function)
transform	期待される値が存在する場合、変換された期待される値を含む expected を返し、そうでなければ expected 自体を返す (public member function)
or_else	期待される値を保持している場合、expected 自体を返し、そうでなければ期待されない値に対して与えられた関数を実行した結果を返す (public member function)
transform_error	期待される値を保持している場合、expected 自体を返し、そうでなければ変換された期待されない値を含む expected を返す (public member function)
変更
emplace	期待される値を直接構築する (public member function)
swap	内容を交換する (public member function)

非メンバ関数

operator== (C++23)	expected オブジェクトを比較する (function template)
swap(std::expected) (C++23)	std::swap アルゴリズムを特殊化する (function)

ヘルパークラス

unexpected (C++23)	期待されない値として表現される (class template)
bad_expected_access (C++23)	期待されない値を含む expected へのチェック付きアクセスを示す例外 (class template)
unexpectunexpect_t (C++23)	expected 内の期待されない値を直接構築するためのタグ (tag)

備考

同様の機能を持つ型は、RustではResult、HaskellではEitherと呼ばれています。

機能テストマクロ	値	規格	機能
__cpp_lib_expected	202202L	(C++23)	クラステンプレート std::expected と関連するヘルパークラス
	202211L	(C++23)	std::expected のためのモナディック関数

例

このコードを実行

#include <cmath>
#include <expected>
#include <iomanip>
#include <iostream>
#include <string_view>
 
enum class parse_error
{
    invalid_input,
    overflow
};
 
auto parse_number(std::string_view& str) -> std::expected<double, parse_error>
{
    const char* begin = str.data();
    char* end;
    double retval = std::strtod(begin, &end);
 
    if (begin == end)
        return std::unexpected(parse_error::invalid_input);
    else if (std::isinf(retval))
        return std::unexpected(parse_error::overflow);
 
    str.remove_prefix(end - begin);
    return retval;
}
 
int main()
{
    auto process = [](std::string_view str)
    {
        std::cout << "str: " << std::quoted(str) << ", ";
        if (const auto num = parse_number(str); num.has_value())
            std::cout << "value: " << *num << '\n';
            // If num did not have a value, dereferencing num
            // would cause an undefined behavior, and
            // num.value() would throw std::bad_expected_access.
            // num.value_or(123) uses specified default value 123.
        else if (num.error() == parse_error::invalid_input)
            std::cout << "error: invalid input\n";
        else if (num.error() == parse_error::overflow)
            std::cout << "error: overflow\n";
        else
            std::cout << "unexpected!\n"; // or invoke std::unreachable();
    };
 
    for (auto src : {"42", "42abc", "meow", "inf"})
        process(src);
}

出力

str: "42", value: 42
str: "42abc", value: 42
str: "meow", error: invalid input
str: "inf", error: overflow

欠陥報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 4141	C++23	ストレージの要件 紛らわしかった	保持されるオブジェクトは expected オブジェクトの内部にネストされる

参照

• C++23標準 (ISO/IEC 14882:2024)

• 22.8 Expected objects [expected]

関連項目

variant (C++17)	型安全な判別共用体 (クラステンプレート)
optional (C++17)	オブジェクトを保持しているかもしれないし、していないかもしれないラッパー (クラステンプレート)