Provided by: libstdc++-14-doc_14-20240412-0ubuntu1_all bug

NAME

       std::error_category

SYNOPSIS

       #include <system_error>

   Public Member Functions
       error_category (const error_category &)=delete
       virtual error_condition default_error_condition (int __i) const noexcept
           Return an error_condition corresponding to i in this category.
       virtual bool equivalent (const error_code &__code, int __i) const noexcept
           Test whether code corresponds to i for this category.
       virtual bool equivalent (int __i, const error_condition &__cond) const noexcept
           Test whether cond corresponds to i for this category.
       virtual string message (int) const =0
       virtual const char * name () const noexcept=0
           A string that identifies the error category.
       strong_ordering operator<=> (const error_category &__rhs) const noexcept
           Ordered comparison that defines a total order for error categories.
       error_category & operator= (const error_category &)=delete
       bool operator== (const error_category &__other) const noexcept
           An error_category only compares equal to itself.

Detailed Description

       Abstract base class for types defining a category of error codes.

       An error category defines a context that gives meaning to the integer stored in an
       error_code or error_condition object. For example, the standard errno constants such a
       EINVAL and ENOMEM are associated with the 'generic' category and other OS-specific error
       numbers are associated with the 'system' category, but a user-defined category might give
       different meanings to the same numerical values.

       A user-defined category can override the equivalent member functions to define
       correspondence between errors in different categories. For example, a category for errors
       from disk I/O could consider some of its error numbers equivalent to ENOSPC and ENOENT in
       the generic category.

       Since
           C++11

Member Function Documentation

   virtual error_condition std::error_category::default_error_condition (int __i) const
       [virtual],  [noexcept]
       Return an error_condition corresponding to i in this category.

   virtual bool std::error_category::equivalent (const error_code & __code, int __i) const
       [virtual],  [noexcept]
       Test whether code corresponds to i for this category.

   virtual bool std::error_category::equivalent (int __i, const error_condition & __cond) const
       [virtual],  [noexcept]
       Test whether cond corresponds to i for this category.

   virtual const char * std::error_category::name () const [pure virtual],  [noexcept]
       A string that identifies the error category.

   strong_ordering std::error_category::operator<=> (const error_category & __rhs) const
       [inline],  [noexcept]
       Ordered comparison that defines a total order for error categories.

   bool std::error_category::operator== (const error_category & __other) const [inline],
       [noexcept]
       An error_category only compares equal to itself.

Author

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

                                            libstdc++                   std::error_category(3cxx)