std:: optional

クラステンプレート std::optional は、オプショナルな保持値、すなわち存在する場合と存在しない場合がある値を管理します。

optional の一般的な使用例は、失敗する可能性のある関数の戻り値です。他のアプローチ（例えば std:: pair < T, bool > など）とは対照的に、 optional は構築コストが高いオブジェクトを適切に扱え、意図が明示的に表現されるため可読性が高くなります。

任意の時点における optional のインスタンスは、 値を含む か、または 値を含まない かのいずれかです。

optional が値を含む場合、その値は optional オブジェクト内に ネストされている ことが保証されます。したがって、 optional オブジェクトはポインタではなくオブジェクトをモデル化します。たとえ operator*() と operator->() が定義されていても同様です。

optional<T> 型のオブジェクトが boolへの文脈的変換 bool が行われる場合、オブジェクトが値を保持しているときは true を返し、値を保持していないときは false を返します。

optional オブジェクトは以下の条件で値を保持します：

• オブジェクトは、型 T の値、または値を含む別の optional で初期化/代入されます。

オブジェクトは以下の条件下で値を保持していません：

• オブジェクトはデフォルト初期化されます。
• オブジェクトが std::nullopt_t 型の値、または値を含まない optional オブジェクトで初期化/代入されます。
• メンバー関数 reset() が呼び出されます。

オプショナルな参照、関数、配列、または（CV修飾された可能性のある） void は存在しません。そのような型で optional をインスタンス化するプログラムは不適格です。さらに、 optional を（CV修飾された可能性のある）タグ型 std::nullopt_t または std::in_place_t でインスタンス化するプログラムも不適格です。

テンプレートパラメータ

ネストされた型

Container のイテレータ型に対するすべての要件は、 optional の iterator 型にも同様に適用されます。

データメンバ

メンバー関数

非メンバー関数

ヘルパークラス

ヘルパー

ヘルパー特殊化

この特殊化は、 ranges::enable_view が optional を view として満たすようにする。

この format_kind の特殊化は、 optional の 範囲フォーマットサポート を無効にします。

推論ガイド

注記

例

#include <iostream>
#include <optional>
#include <string>
// optional can be used as the return type of a factory that may fail
std::optional<std::string> create(bool b)
{
    if (b)
        return "Godzilla";
    return {};
}
// std::nullopt can be used to create any (empty) std::optional
auto create2(bool b)
{
    return b ? std::optional<std::string>{"Godzilla"} : std::nullopt;
}
int main()
{
    std::cout << "create(false) returned "
              << create(false).value_or("empty") << '\n';
    // optional-returning factory functions are usable as conditions of while and if
    if (auto str = create2(true))
        std::cout << "create2(true) returned " << *str << '\n';
}

create(false) returned empty
create2(true) returned Godzilla

欠陥報告

以下の動作変更の欠陥報告書は、以前に公開されたC++規格に対して遡及的に適用されました。

関連項目