Namespaces
Variants
Views
Actions

std::optional

From cppreference.com
< cpp‎ | experimental
Revision as of 17:34, 9 July 2013 by P12bot (Talk | contribs)

Template:cpp/utility/optional/navbar

Defined in header <optional>
template< class T >
class optional;
(since C++14)

The class template std::optional manages an optional contained value. The value may be in either initialized or uninitialized state.

A common use case for optional is the return value of a function that may fail. As opposed to other approaches, such as std::pair<T,bool>, optional handles expensive to construct objects well and is more readable, as the intent is expressed explicitly.

The value is guaranteed to be allocated within the optional object itself, i.e. no dynamic memory allocation ever takes place. Thus, optional object models an object, not a pointer, even though the operator*() and operator->() are defined.

A optional object with a value in initialized state is called engaged, whereas if the value is in uninitialized state, the object is called disengaged.

The optional object is engaged on the following conditions:

  • The object is initialized with a value of type T
  • The object is assigned an engaged optional.

The object is disengaged on the following conditions:

  • The object is default-initialized.
  • The object is initialized with a value of std::nullopt_t or a disengaged optional object.
  • The object is assigned a value of std::nullopt_t or a disengaged optional.

Contents

Template parameters

T - the type of the value to manage initialization state for. The type must meet the requirements of Destructible

Member types

Member type Definition
value_type T

Member functions

Template:cpp/utility/optional/dsc constructorTemplate:cpp/utility/optional/dsc destructorTemplate:cpp/utility/optional/dsc operator=Template:cpp/utility/optional/dsc operator*Template:cpp/utility/optional/dsc operator boolTemplate:cpp/utility/optional/dsc valueTemplate:cpp/utility/optional/dsc value orTemplate:cpp/utility/optional/dsc swapTemplate:cpp/utility/optional/dsc emplace
Observers
Modifiers

Non-member functions

Template:cpp/utility/optional/dsc operator cmpTemplate:cpp/utility/optional/dsc make optionalTemplate:cpp/utility/optional/dsc swap2

Helper classes

Template:cpp/utility/optional/dsc hash