std::exception_ptr(3cxx)

📦
version 16-20260322 · 5 versions
, in ubuntu resolute

🌸 std::exception_ptr 🌸

hey bestie 💖 welcome to the 3cxx section of the libstdc++ manuals — this is the page for std::exception_ptr, and honestly? it's giving "small but mighty." let's get into it 🦋

✨ NAME ✨

std::exception_ptr — an opaque pointer to an arbitrary exception. that's it. that's the whole vibe. 🙈

🎀 SYNOPSIS 🎀

first things first, you gotta pull in the header:

#include <exception>

👑 Public Member Functions 👑

  • exception_ptr (const exception_ptr &) noexcept — copy constructor, noexcept, so it will never throw at you. slay.
  • exception_ptr (exception_ptr &&__o) noexcept — move constructor, also noexcept, takes the __o rvalue reference and does its little move thing. ✨
  • exception_ptr (nullptr_t) noexcept — construct one from nullptr_t. yes, noexcept too. 💅
  • const class std::type_info * __cxa_exception_type () const noexcept — hands you back a const class std::type_info *. it's const and noexcept, so it's the chill, well-behaved one of the group. 🌈
  • operator bool () const noexcept — lets you use an exception_ptr in a boolean context, const and noexcept. vibe check built right in. ⭐
  • exception_ptr & operator= (const exception_ptr &) noexcept — copy assignment, noexcept, returns a reference to the exception_ptr. 💜
  • exception_ptr & operator= (exception_ptr &&__o) noexcept — move assignment, noexcept, takes __o and returns a reference. 🧚
  • void swap (exception_ptr &) noexcept — swaps with another exception_ptr &, returns void, and yep, noexcept. iconic behavior. 🎀

🫶 Friends 🫶

these are the friend functions, aka the inner circle:

  • bool operator== (const exception_ptr &, const exception_ptr &) — takes two const exception_ptr & and gives you back a bool. it's marked noexcept=default. 🔥
  • exception_ptr std::current_exception () noexcept — returns an exception_ptr and is noexcept. main character energy, fr fr.
  • template<typename _Ex> exception_ptr std::make_exception_ptr (_Ex) noexcept — a template over _Ex that hands you an exception_ptr, and it's noexcept. ✨
  • void std::rethrow_exception (exception_ptr) — returns void, takes an exception_ptr. 😭 (yes bestie, it does what the name says)
  • void swap (exception_ptr &__lhs, exception_ptr &__rhs) — the free-function swap. returns void, takes __lhs and __rhs, both exception_ptr &. 🌸
heads up bestie: these are not member symbols. i repeat — not member symbols.
  • void swap (exception_ptr &__lhs, exception_ptr &__rhs) — yeah it's listed here too. same signature, same energy. it's just also living in the related-symbols neighborhood. no cap. 👑

🌟 Detailed Description 🌟

okay so here's the tea 🍓:

an opaque pointer to an arbitrary exception.

the actual name of this type is unspecified, so the alias std::exception_ptr should be used to refer to it. iykyk — don't go trying to name the type yourself, just use the alias, bestie. 🦋

🕰️ Since 🕰️

  • C++11 (but usable in C++98 as a GCC extension) 💜

🌈 Author 🌈

Generated automatically by Doxygen for libstdc++ from the source code. (not a human girlie writing this, a whole tool. respect. 🎀)

and that's the page, bestie!! 💖 this was the 3cxx manual, brought to you by libstdc++ — mwah, go forth and catch those exceptions responsibly 🫶✨💅

📦 where this page comes from