#include "cetl/pf17/optional.hpp"

Public Types
using	value_type = T

Public Member Functions
constexpr	optional () noexcept=default

constexpr	optional (const nullopt_t) noexcept

constexpr	optional (const optional &)=default

constexpr	optional (optional &&) noexcept(std::is_nothrow_move_constructible< T >::value)=default

template<typename U, std::enable_if_t< detail::opt::enable_ctor4< T, U, false >, int > = 0>
	optional (const optional< U > &other)

template<typename U, std::enable_if_t< detail::opt::enable_ctor4< T, U, true >, int > = 0>
	optional (const optional< U > &other)

template<typename U, std::enable_if_t< detail::opt::enable_ctor5< T, U, false >, int > = 0>
	optional (optional< U > &&other)

template<typename U, std::enable_if_t< detail::opt::enable_ctor5< T, U, true >, int > = 0>
	optional (optional< U > &&other)

template<typename... Args>
constexpr	optional (const in_place_t, Args &&... args) noexcept(std::is_nothrow_constructible< T, Args... >::value)

template<typename U, typename... Args>
constexpr	optional (const in_place_t, std::initializer_list< U > il, Args &&... args) noexcept(std::is_nothrow_constructible< T, std::initializer_list< U >, Args... >::value)

template<typename U = T, std::enable_if_t< detail::opt::enable_ctor8< T, U, false >, int > = 0>
constexpr	optional (U &&value) noexcept(std::is_nothrow_constructible< T, U >::value)

template<typename U = T, std::enable_if_t< detail::opt::enable_ctor8< T, U, true >, int > = 0>
constexpr	optional (U &&value) noexcept(std::is_nothrow_constructible< T, U >::value)

optional &	operator= (const nullopt_t) noexcept

optional &	operator= (const optional &other)=default

constexpr optional &	operator= (optional &&other) noexcept(std::is_nothrow_move_assignable< T >::value &&std::is_nothrow_move_constructible< T >::value)=default

template<typename U = T, std::enable_if_t<!std::is_same< std::decay_t< U >, optional >::value, int > = 0, std::enable_if_t< std::is_constructible< T, U >::value, int > = 0, std::enable_if_t< std::is_assignable< T &, U >::value, int > = 0, std::enable_if_t<(!std::is_scalar< T >::value)\|\|(!std::is_same< std::decay_t< U >, T >::value), int > = 0>
optional &	operator= (U &&value)

template<typename U, std::enable_if_t<!detail::opt::convertible< T, optional< U > >, int > = 0, std::enable_if_t<!detail::opt::assignable< T &, optional< U > >, int > = 0, std::enable_if_t< std::is_constructible< T, const U & >::value, int > = 0, std::enable_if_t< std::is_assignable< T &, const U & >::value, int > = 0>
optional &	operator= (const optional< U > &other)

template<typename U, std::enable_if_t<!detail::opt::convertible< T, optional< U > >, int > = 0, std::enable_if_t<!detail::opt::assignable< T &, optional< U > >, int > = 0, std::enable_if_t< std::is_constructible< T, U >::value, int > = 0, std::enable_if_t< std::is_assignable< T &, U >::value, int > = 0>
optional &	operator= (optional< U > &&other)

void	reset ()

CETL_NODISCARD constexpr bool	has_value () const noexcept

template<typename... Args>
T &	emplace (Args &&... args) noexcept(std::is_nothrow_constructible< T, Args... >::value)

template<typename U, typename... Args>
T &	emplace (std::initializer_list< U > il, Args &&... args) noexcept(std::is_nothrow_constructible< T, std::initializer_list< U >, Args... >::value)

void	swap (optional &other) noexcept(std::is_nothrow_move_constructible< T >::value &&is_nothrow_swappable_v< T >)

CETL_NODISCARD constexpr T &	value () &

CETL_NODISCARD constexpr const T &	value () const &

CETL_NODISCARD constexpr T &&	value () &&

CETL_NODISCARD constexpr const T &&	value () const &&

template<class U>
CETL_NODISCARD constexpr T	value_or (U &&default_value) const &

template<class U>
CETL_NODISCARD constexpr T	value_or (U &&default_value) &&

constexpr	operator bool () const noexcept

constexpr T *	operator-> () noexcept

constexpr const T *	operator-> () const noexcept

constexpr T &	operator* () &noexcept

constexpr const T &	operator* () const &noexcept

constexpr T &&	operator* () &&noexcept

constexpr const T &&	operator* () const &&noexcept

Friends
template<typename, bool>
struct	detail::opt::base_destruction

Detailed Description

template<typename T>
class cetl::pf17::optional< T >

A strict implementation of C++17 std::optional.

Constructor & Destructor Documentation

◆ optional() [1/8]

template<typename T>

cetl::pf17::optional< T >::optional ( )

constexprdefaultnoexcept

Constructor 1.

◆ optional() [2/8]

template<typename T>

cetl::pf17::optional< T >::optional ( const optional< T > & )

constexprdefault

Constructor 2.

◆ optional() [3/8]

template<typename T>

cetl::pf17::optional< T >::optional ( optional< T > && ) const

constexprdefaultnoexcept

Constructor 3.

References value().

◆ optional() [4/8]

template<typename T>

template<typename U, std::enable_if_t< detail::opt::enable_ctor4< T, U, false >, int > = 0>

cetl::pf17::optional< T >::optional ( const optional & other )

inline

Constructor 4.

◆ optional() [5/8]

template<typename T>

template<typename U, std::enable_if_t< detail::opt::enable_ctor5< T, U, false >, int > = 0>

cetl::pf17::optional< T >::optional ( optional && other )

inline

Constructor 5.

◆ optional() [6/8]

template<typename T>

template<typename... Args>

cetl::pf17::optional< T >::optional	(	const in_place_t	,
		Args &&...	args )

inlineexplicitconstexprnoexcept

Constructor 6.

References cetl::pf17::in_place, and value().

◆ optional() [7/8]

template<typename T>

template<typename U, typename... Args>

cetl::pf17::optional< T >::optional	(	const in_place_t	,
		std::initializer_list< U >	il,
		Args &&...	args )

inlineexplicitconstexprnoexcept

Constructor 7.

References cetl::pf17::in_place, and value().

◆ optional() [8/8]

template<typename T>

template<typename U = T, std::enable_if_t< detail::opt::enable_ctor8< T, U, false >, int > = 0>

cetl::pf17::optional< T >::optional ( U && value )

inlineconstexprnoexcept

Constructor 8.

References cetl::pf17::in_place, and value().

Member Function Documentation

◆ emplace()

template<typename T>

template<typename... Args>

T & cetl::pf17::optional< T >::emplace ( Args &&... args )

inlinenoexcept

Construct the value in-place.

If the optional is already engaged, the value is destroyed and replaced with the new value.

References std::addressof(), std::forward(), reset(), and value().

Referenced by swap().

Here is the caller graph for this function:

◆ has_value()

template<typename T>

CETL_NODISCARD constexpr bool cetl::pf17::optional< T >::has_value ( ) const

inlineconstexprnoexcept

True if the optional is engaged.

References CETL_NODISCARD.

Referenced by operator bool(), cetl::pf17::operator!=(), cetl::pf17::operator!=(), cetl::pf17::operator<(), cetl::pf17::operator<(), cetl::pf17::operator<(), cetl::pf17::operator<=(), cetl::pf17::operator<=(), cetl::pf17::operator==(), cetl::pf17::operator==(), cetl::pf17::operator==(), cetl::pf17::operator>(), cetl::pf17::operator>(), cetl::pf17::operator>=(), cetl::pf17::operator>=(), swap(), and value_or().

Here is the caller graph for this function:

◆ operator bool()

template<typename T>

cetl::pf17::optional< T >::operator bool ( ) const

inlineexplicitconstexprnoexcept

Alias of has_value().

References has_value().

◆ operator*()

template<typename T>

T & cetl::pf17::optional< T >::operator* ( ) &

inlineconstexprnoexcept

The dereference operator provides unchecked access to the value.

Behavior undefined if the optional is not engaged.

◆ operator->()

template<typename T>

T * cetl::pf17::optional< T >::operator-> ( )

inlineconstexprnoexcept

The arrow operator provides unchecked access to the value.

Behavior undefined if the optional is not engaged.

◆ operator=() [1/6]

template<typename T>

optional & cetl::pf17::optional< T >::operator= ( const nullopt_t )

inlinenoexcept

Assignment 1.

References reset().

◆ operator=() [2/6]

template<typename T>

optional & cetl::pf17::optional< T >::operator= ( const optional< T > & other )

default

Assignment 2.

◆ operator=() [3/6]

template<typename T>

template<typename U, std::enable_if_t<!detail::opt::convertible< T, optional >, int > = 0, std::enable_if_t<!detail::opt::assignable< T &, optional >, int > = 0, std::enable_if_t< std::is_constructible< T, const U & >::value, int > = 0, std::enable_if_t< std::is_assignable< T &, const U & >::value, int > = 0>

optional & cetl::pf17::optional< T >::operator= ( const optional & other )

inline

Assignment 5.

References std::addressof(), and reset().

◆ operator=() [4/6]

template<typename T>

optional & cetl::pf17::optional< T >::operator= ( optional< T > && other ) const &&

constexprdefaultnoexcept

Assignment 3.

References value().

◆ operator=() [5/6]

template<typename T>

template<typename U, std::enable_if_t<!detail::opt::convertible< T, optional >, int > = 0, std::enable_if_t<!detail::opt::assignable< T &, optional >, int > = 0, std::enable_if_t< std::is_constructible< T, U >::value, int > = 0, std::enable_if_t< std::is_assignable< T &, U >::value, int > = 0>

optional & cetl::pf17::optional< T >::operator= ( optional && other )

inline

Assignment 6.

References std::addressof(), and reset().

◆ operator=() [6/6]

template<typename T>

template<typename U = T, std::enable_if_t<!std::is_same< std::decay_t, optional >::value, int > = 0, std::enable_if_t< std::is_constructible< T, U >::value, int > = 0, std::enable_if_t< std::is_assignable< T &, U >::value, int > = 0, std::enable_if_t<(!std::is_scalar< T >::value)||(!std::is_same< std::decay_t, T >::value), int > = 0>

optional & cetl::pf17::optional< T >::operator= ( U && value )

inline

Assignment 4.

References std::addressof(), std::forward(), and value().

◆ reset()

template<typename T>

void cetl::pf17::optional< T >::reset ( )

inline

Destroy the value if engaged, otherwise do nothing.

Referenced by emplace(), operator=(), operator=(), operator=(), and swap().

Here is the caller graph for this function:

◆ swap()

template<typename T>

void cetl::pf17::optional< T >::swap ( optional< T > & other )

inlinenoexcept

Swaps two optionals. If either is not engaged, acts like move assignment.

References emplace(), has_value(), cetl::pf17::is_nothrow_swappable_v, reset(), swap(), and std::swap().

Referenced by swap().

Here is the caller graph for this function:

◆ value()

template<typename T>

CETL_NODISCARD constexpr T & cetl::pf17::optional< T >::value ( ) &

inlineconstexpr

Checked access to the value.

If the optional is not engaged, the behavior depends on whether exception handling is enabled:

If exceptions are enabled, a bad_optional_access exception is thrown.
If exceptions are disabled, the behavior is undefined.

References CETL_NODISCARD.

Referenced by emplace(), operator=(), operator=(), optional(), optional(), optional(), and optional().

Here is the caller graph for this function:

◆ value_or()

template<typename T>

template<class U>

CETL_NODISCARD constexpr T cetl::pf17::optional< T >::value_or ( U && default_value ) const &

inlineconstexpr

Checked access to the value with a fallback value.

If the optional is engaged, a copy of its value is returned; otherwise, the default value is converted to T and the result is returned.

References CETL_NODISCARD, std::forward(), and has_value().

The documentation for this class was generated from the following file:

/__w/CETL/CETL/include/cetl/pf17/optional.hpp

	CETL 0.0.0

Public Types

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ optional() [1/8]

◆ optional() [2/8]

◆ optional() [3/8]

◆ optional() [4/8]

◆ optional() [5/8]

◆ optional() [6/8]

◆ optional() [7/8]

◆ optional() [8/8]

Member Function Documentation

◆ emplace()

◆ has_value()

◆ operator bool()

◆ operator*()

◆ operator->()

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

◆ reset()

◆ swap()

◆ value()

◆ value_or()