Namespaces
Variants

Standard library header <optional> (C++17)

From cppreference.net
Standard library headers

Dieser Header ist Teil der allgemeinen Utility-Bibliothek .

Inhaltsverzeichnis

Includes

(C++20)
Drei-Wege-Vergleichsoperator Unterstützung

Klassen

(C++17)
ein Wrapper, der möglicherweise ein Objekt enthält
(Klassentemplate)
Exception, die einen geprüften Zugriff auf ein optional ohne Wert anzeigt
(Klasse)
Hash-Unterstützung für std::optional
(Klassentemplate-Spezialisierung)
(C++17)
Indikator für ein std::optional , das keinen Wert enthält
(Klasse)
Vorwärtsdeklarationen
Definiert im Header <functional>
(C++11)
Hash-Funktionsobjekt
(Klassentemplate)

Konstanten

(C++17)
ein Objekt vom Typ nullopt_t
(Konstante)

Funktionen

Vergleich
(C++17) (C++17) (C++17) (C++17) (C++17) (C++17) (C++20)
vergleicht optional -Objekte
(Funktionstemplate)
Spezialisierte Algorithmen
spezialisiert den std::swap -Algorithmus
(Funktionstemplate)
erstellt ein optional -Objekt
(Funktionstemplate)

Zusammenfassung

// größtenteils freistehend
#include <compare>
namespace std {
  // Klassentemplate optional
  template<class T> class optional;                             // teilweise freistehend
  template<class T> constexpr bool ranges::enable_view<optional<T>> = true;
  template<class T> constexpr auto format_kind<optional<T>> = range_format::deaktiviert;
  template<class T>
  concept /*is-derived-from-optional*/ = requires(const T& t) { // exposition-only
    []<class U>(const optional<U>&) {}(t);
  };
  // Zustandsindikator ohne Wert
  struct nullopt_t
  { /* siehe Beschreibung */
  };
  inline constexpr nullopt_t nullopt(/* nicht spezifiziert */);
  // class bad_optional_access
  class bad_optional_access;
  // relational operators
  template<class T, class U>
  constexpr bool operator==(const optional<T>&, const optional<U>&);
  template<class T, class U>
  constexpr bool operator!=(const optional<T>&, const optional<U>&);
  template<class T, class U>
  constexpr bool operator<(const optional<T>&, const optional<U>&);
  template<class T, class U>
  constexpr bool operator>(const optional<T>&, const optional<U>&);
  template<class T, class U>
  constexpr bool operator<=(const optional<T>&, const optional<U>&);
  template<class T, class U>
  constexpr bool operator>=(const optional<T>&, const optional<U>&);
  template<class T, three_way_comparable_with<T> U>
  constexpr compare_three_way_result_t<T, U> operator<=>(const optional<T>&,
                                                         const optional<U>&);
  // Vergleich mit nullopt
  template<class T> constexpr bool operator==(const optional<T>&, nullopt_t) noexcept;
  template<class T>
  constexpr strong_ordering operator<=>(const optional<T>&, nullopt_t) noexcept;
  // Vergleich mit T
  template<class T, class U> constexpr bool operator==(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator==(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator!=(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator!=(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator<(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator<(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator>(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator>(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator<=(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator<=(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator>=(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator>=(const T&, const optional<U>&);
  template<class T, class U>
    requires(!/*is-derived-from-optional*/<U>) && three_way_comparable_with<T, U>
  constexpr compare_three_way_result_t<T, U> operator<=>(const optional<T>&, const U&);
  // spezialisierte Algorithmen
  template<class T>
  constexpr void swap(optional<T>&, optional<T>&) noexcept(/* siehe Beschreibung */);
  template<class T> constexpr optional<decay_t<T>> make_optional(T&&);
  template<class T, class... Args> constexpr optional<T> make_optional(Args&&... args);
  template<class T, class U, class... Args>
  constexpr optional<T> make_optional(initializer_list<U> il, Args&&... args);
  // Hash-Unterstützung
  template<class T> struct hash;
  template<class T> struct hash<optional<T>>;
}

Klassentemplate std::optional

namespace std {
  template<class T> class optional
  {
  public:
    using value_type = T;
    using iterator = /* implementierungsdefiniert */;
    using const_iterator = /* implementierungsdefiniert */;
    // Konstruktoren
    constexpr optional() noexcept;
    constexpr optional(nullopt_t) noexcept;
    constexpr optional(const optional&);
    constexpr optional(optional&&) noexcept(/* siehe Beschreibung */);
    template<class... Args> constexpr explicit optional(in_place_t, Args&&...);
    template<class U, class... Args>
    constexpr explicit optional(in_place_t, initializer_list<U>, Args&&...);
    template<class U = remove_cv_t<T>>
    constexpr explicit(/* siehe Beschreibung */) optional(U&&);
    template<class U>
    constexpr explicit(/* siehe Beschreibung */) optional(const optional<U>&);
    template<class U> constexpr explicit(/* siehe Beschreibung */) optional(optional<U>&&);
    // Destruktor
    constexpr ~optional();
    // Zuweisung
    constexpr optional& operator=(nullopt_t) noexcept;
    constexpr optional& operator=(const optional&);
    constexpr optional& operator=(optional&&) noexcept(/* siehe Beschreibung */);
    template<class U = remove_cv_t<T>> constexpr optional& operator=(U&&);
    template<class U> constexpr optional& operator=(const optional<U>&);
    template<class U> constexpr optional& operator=(optional<U>&&);
    template<class... Args> constexpr T& emplace(Args&&...);
    template<class U, class... Args> constexpr T& emplace(initializer_list<U>, Args&&...);
    // swap
    constexpr void swap(optional&) noexcept(/* siehe Beschreibung */);
    // Iterator-Unterstützung
    constexpr iterator begin() noexcept;
    constexpr const_iterator begin() const noexcept;
    constexpr iterator end() noexcept;
    constexpr const_iterator end() const noexcept;
    // Beobachter
    constexpr const T* operator->() const noexcept;
    constexpr T* operator->() noexcept;
    constexpr const T& operator*() const& noexcept;
    constexpr T& operator*() & noexcept;
    constexpr T&& operator*() && noexcept;
    constexpr const T&& operator*() const&& noexcept;
    constexpr explicit operator bool() const noexcept;
    constexpr bool has_value() const noexcept;
    constexpr const T& value() const&;   // freestanding-deleted
    constexpr T& value() &;              // freestanding-deleted
    constexpr T&& value() &&;            // freestanding-deleted
    constexpr const T&& value() const&&; // freestanding-deleted
    template<class U = remove_cv_t<T>> constexpr T value_or(U&&) const&;
    template<class U = remove_cv_t<T>> constexpr T value_or(U&&) &&;
    // monadische Operationen
    template<class F> constexpr auto and_then(F&& f) &;
    template<class F> constexpr auto and_then(F&& f) &&;
    template<class F> constexpr auto and_then(F&& f) const&;
    template<class F> constexpr auto and_then(F&& f) const&&;
    template<class F> constexpr auto transform(F&& f) &;
    template<class F> constexpr auto transform(F&& f) &&;
    template<class F> constexpr auto transform(F&& f) const&;
    template<class F> constexpr auto transform(F&& f) const&&;
    template<class F> constexpr optional or_else(F&& f) &&;
    template<class F> constexpr optional or_else(F&& f) const&;
    // Modifikatoren
    constexpr void reset() noexcept;
  private:
    T* val; // exposition-only
  };
  template<class T> optional(T) -> optional<T>;
}

Klassentemplate std::bad_optional_access

namespace std {
  class bad_optional_access : public exception
  {
  public:
    // für die Spezifikation der speziellen Elementfunktionen
    constexpr const char* what() const noexcept override;
  };
}