std::error_code(3cxx)

std::error_code 💅 (from the 3cxx manual, libstdc++ edition)

okay bestie, welcome to std::error_code — it's giving main character energy in the 3cxx manual, and we're gonna get through every signature together 🫶✨

💖 NAME 💖

std::error_code — that's the name, no cap.

✨ SYNOPSIS ✨

#include <system_error>

🫶 Public Member Functions 🫶

• template<typename _ErrorCodeEnum , typename = _Check<_ErrorCodeEnum>> error_code (_ErrorCodeEnum __e) noexcept — Initialize with a user-defined type, by calling make_error_code.
• error_code (const error_code &)=default — defaulted, periodt.
• error_code (int __v, const error_category &__cat) noexcept — constructor with __v and __cat, exactly like the signature says.
• void assign (int __v, const error_category &__cat) noexcept — assign time, bestie.
• const error_category & category () const noexcept — The error category that this error belongs to.
• void clear () noexcept — clear it out, that's the whole signature.
• error_condition default_error_condition () const noexcept — An error_condition for this error's category and value.
• string message () const — The category's description of the value.
• operator bool () const noexcept — Test whether value() is non-zero.
• error_code & operator= (const error_code &)=default — defaulted assignment vibe.
• int value () const noexcept — The error value.

🌈 Related Symbols 🌈

Note that these are not member symbols. iykyk 🫶

• error_code make_error_code (errc __e) noexcept — related symbol, not a member, obviously.
• strong_ordering operator (const error_code &__lhs, const error_code &__rhs) noexcept — related symbol, not a member.
• template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & operator<< (basic_ostream< _CharT, _Traits > &__os, const error_code &__e) — related symbol, not a member.

🦋 Detailed Description 🦋

🪩 Class error_code 🪩

Okay so error_code is a value type storing an integer error number and a category that gives meaning to the error number. Typically this is done close the the point where the error happens, to capture the original error value. (yes, I kept the double “the the” exactly — character-for-character energy 💅)

An error_code object can be used to store the original error value emitted by some subsystem, with a category relevant to the subsystem. For example, errors from POSIX library functions can be represented by an errno value and the 'generic' category, but errors from an HTTP library might be represented by an HTTP response status code (e.g. 404) and a custom category defined by the library.

⭐ Since ⭐

C++11 — the era, the moment, the standard, bestie.

🧚 Constructor & Destructor Documentation 🧚

• template<typename _ErrorCodeEnum , typename = _Check<_ErrorCodeEnum>> std::error_code::error_code (_ErrorCodeEnum __e) [inline], [noexcept] — Initialize with a user-defined type, by calling make_error_code.
  • References make_error_code().

🌈 Member Function Documentation 🌈

• const error_category & std::error_code::category () const [inline], [noexcept] — The error category that this error belongs to.
  • Referenced by message().
• error_condition std::error_code::default_error_condition () const [noexcept] — An error_condition for this error's category and value.
• string std::error_code::message () const [inline] — The category's description of the value.
  • References category(), and value().
• std::error_code::operator bool () const [inline], [explicit], [noexcept] — Test whether value() is non-zero.
• int std::error_code::value () const [inline], [noexcept] — The error value.
  • Referenced by message().

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code.

---

okay that's the whole page, bestie! 💖 The footer energy is source/version libstdc++ and page std::error_code(3cxx); there's no date printed in the footer text here, so I'm not inventing one — periodt 🫶✨