std::optional::value_or

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)

Dynamic memory management

Error handling

Program utilities

Variadic functions

Date and time

Function objects

initializer_list (C++11)

bitset

hash (C++11)

Relational operators

rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=

optional, any and variant (C++17)

optional

any

variant

in_placein_place_typein_place_indexin_place_tin_place_type_tin_place_index_t

Pairs and tuples

pair

tuple (C++11)

apply (C++17)

make_from_tuple (C++17)

piecewise_construct_t (C++11)

piecewise_construct (C++11)

integer_sequence (C++14)

Swap, forward and move

swap

exchange (C++14)

forward (C++11)

move (C++11)

move_if_noexcept (C++11)

Elementary string conversions

to_chars (C++17)

from_chars (C++17)

chars_format (C++17)

Type operations

declval (C++11)

as_const (C++17)

 

std::optional

Member functions

optional::optional

optional::~optional

optional::operator=

Observers

optional::operator->optional::operator*

optional::operator booloptional::has_value

optional::value

optional::value_or

Modifiers

optional::emplace

optional::swap

optional::reset

Non-member functions

operator==operator!=operator<operator<=operator>operator>=

make_optional

swap

Helper classes

hash

nullopt_t

in_place_t

bad_optional_access

Helper objects

nullopt

in_place

 

template< class U > constexpr T value_or( U&& default_value ) const&;		(since C++17)
template< class U > constexpr T value_or( U&& default_value ) &&;		(since C++17)

Returns the contained value if *this has a value, otherwise returns default_value.

1) Equivalent to bool(*this) ? **this : static_cast<T>(std::forward<U>(default_value))

2) Equivalent to bool(*this) ? std::move(**this) : static_cast<T>(std::forward<U>(default_value))

Parameters

default_value	-	the value to use in case *this is empty
Type requirements
- T must meet the requirements of CopyConstructible in order to use overload (1).
- T must meet the requirements of MoveConstructible in order to use overload (2).
- U&& must be convertible to T

Return value

The current value if *this has a value, or default_value otherwise.

Exceptions

Any exception thrown by the selected constructor of the return value T.

Example

Run this code

#include <optional>
#include <iostream>
#include <cstdlib>
 
std::optional<const char*> maybe_getenv(const char* n)
{
    if(const char* x = std::getenv(n))
       return x;
    else
       return {};
}
int main()
{
     std::cout << maybe_getenv("MYPWD").value_or("(none)") << '\n';
}

Possible output:

(none)

See also

value

returns the contained value (public member function)