19 Diagnostics library [diagnostics]

19.1 General [diagnostics.general]

1

This Clause describes components that C++ programs may use to detect and report error conditions.

2

The following subclauses describe components for reporting several kinds of exceptional conditions, documenting program assertions, and a global variable for error number codes, as summarized in Table [tab:diagnostics.lib.summary].

Table 41 — Diagnostics library summary
Subclause Header(s)
[std.exceptions] Exception classes <stdexcept>
[assertions] Assertions <cassert>
[errno] Error numbers <cerrno>
[syserr] System error support <system_error>

19.2 Exception classes [std.exceptions]

1

The Standard C++ library provides classes to be used to report certain errors ([res.on.exception.handling]) in C++ programs. In the error model reflected in these classes, errors are divided into two broad categories: logic errors and runtime errors.

2

The distinguishing characteristic of logic errors is that they are due to errors in the internal logic of the program. In theory, they are preventable.

3

By contrast, runtime errors are due to events beyond the scope of the program. They cannot be easily predicted in advance. The header <stdexcept> defines several types of predefined exceptions for reporting errors in a C++ program. These exceptions are related by inheritance.

Header <stdexcept> synopsis

namespace std {
  class logic_error;
    class domain_error;
    class invalid_argument;
    class length_error;
    class out_of_range;
  class runtime_error;
    class range_error;
    class overflow_error;
    class underflow_error;
}

19.2.1 Class logic_error [logic.error]

namespace std {
  class logic_error : public exception {
  public:
    explicit logic_error(const string& what_arg);
    explicit logic_error(const char* what_arg);
  };
}
1

The class logic_error defines the type of objects thrown as exceptions to report errors presumably detectable before the program executes, such as violations of logical preconditions or class invariants.

logic_error(const string& what_arg);

2

Effects: Constructs an object of class logic_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

logic_error(const char* what_arg);

4

Effects: Constructs an object of class logic_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.2 Class domain_error [domain.error]

namespace std {
  class domain_error : public logic_error {
  public:
    explicit domain_error(const string& what_arg);
    explicit domain_error(const char* what_arg);
  };
}
1

The class domain_error defines the type of objects thrown as exceptions by the implementation to report domain errors.

domain_error(const string& what_arg);

2

Effects: Constructs an object of class domain_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

domain_error(const char* what_arg);

4

Effects: Constructs an object of class domain_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.3 Class invalid_argument [invalid.argument]

namespace std {
  class invalid_argument : public logic_error {
  public:
    explicit invalid_argument(const string& what_arg);
    explicit invalid_argument(const char* what_arg);
  };
}
1

The class invalid_argument defines the type of objects thrown as exceptions to report an invalid argument.

invalid_argument(const string& what_arg);

2

Effects: Constructs an object of class invalid_argument.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

invalid_argument(const char* what_arg);

4

Effects: Constructs an object of class invalid_argument.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.4 Class length_error [length.error]

namespace std {
  class length_error : public logic_error {
  public:
    explicit length_error(const string& what_arg);
    explicit length_error(const char* what_arg);
  };
}
1

The class length_error defines the type of objects thrown as exceptions to report an attempt to produce an object whose length exceeds its maximum allowable size.

length_error(const string& what_arg);

2

Effects: Constructs an object of class length_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

length_error(const char* what_arg);

4

Effects: Constructs an object of class length_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.5 Class out_of_range [out.of.range]

namespace std {
  class out_of_range : public logic_error {
  public:
    explicit out_of_range(const string& what_arg);
    explicit out_of_range(const char* what_arg);
  };
}
1

The class out_of_range defines the type of objects thrown as exceptions to report an argument value not in its expected range.

out_of_range(const string& what_arg);

2

Effects: Constructs an object of class out_of_range.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

out_of_range(const char* what_arg);

4

Effects: Constructs an object of class out_of_range.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.6 Class runtime_error [runtime.error]

namespace std {
  class runtime_error : public exception {
  public:
    explicit runtime_error(const string& what_arg);
    explicit runtime_error(const char* what_arg);
  };
}
1

The class runtime_error defines the type of objects thrown as exceptions to report errors presumably detectable only when the program executes.

runtime_error(const string& what_arg);

2

Effects: Constructs an object of class runtime_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

runtime_error(const char* what_arg);

4

Effects: Constructs an object of class runtime_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.7 Class range_error [range.error]

namespace std {
  class range_error : public runtime_error {
  public:
    explicit range_error(const string& what_arg);
    explicit range_error(const char* what_arg);
  };
}
1

The class range_error defines the type of objects thrown as exceptions to report range errors in internal computations.

range_error(const string& what_arg);

2

Effects: Constructs an object of class range_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

range_error(const char* what_arg);

4

Effects: Constructs an object of class range_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.8 Class overflow_error [overflow.error]

namespace std {
  class overflow_error : public runtime_error {
  public:
    explicit overflow_error(const string& what_arg);
    explicit overflow_error(const char* what_arg);
  };
}
1

The class overflow_error defines the type of objects thrown as exceptions to report an arithmetic overflow error.

overflow_error(const string& what_arg);

2

Effects: Constructs an object of class overflow_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

overflow_error(const char* what_arg);

4

Effects: Constructs an object of class overflow_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.2.9 Class underflow_error [underflow.error]

namespace std {
  class underflow_error : public runtime_error {
  public:
    explicit underflow_error(const string& what_arg);
    explicit underflow_error(const char* what_arg);
  };
}
1

The class underflow_error defines the type of objects thrown as exceptions to report an arithmetic underflow error.

underflow_error(const string& what_arg);

2

Effects: Constructs an object of class underflow_error.

3

Postcondition: strcmp(what(), what_arg.c_str()) == 0.

underflow_error(const char* what_arg);

4

Effects: Constructs an object of class underflow_error.

5

Postcondition: strcmp(what(), what_arg) == 0.

19.3 Assertions [assertions]

1

The header <cassert>, described in (Table [tab:diagnostics.hdr.cassert]), provides a macro for documenting C++ program assertions and a mechanism for disabling the assertion checks.

Table 42 — Header <cassert> synopsis
TypeName(s)
Macro: assert
2

The contents are the same as the Standard C library header <assert.h>.

See also: ISO C 7.2.

19.4 Error numbers [errno]

1

The header <cerrno> is described in Table [tab:diagnostics.hdr.cerrno]. Its contents are the same as the POSIX header <errno.h>, except that errno shall be defined as a macro. [ Note: The intent is to remain in close alignment with the POSIX standard.  — end note ] A separate errno value shall be provided for each thread.

Table 43 — Header <cerrno> synopsis
TypeName(s)
Macros: ECONNREFUSED EIO ENODEV ENOTEMPTY ERANGE
E2BIG ECONNRESET EISCONN ENOENT ENOTRECOVERABLE EROFS
EACCES EDEADLK EISDIR ENOEXEC ENOTSOCK ESPIPE
EADDRINUSE EDESTADDRREQ ELOOP ENOLCK ENOTSUP ESRCH
EADDRNOTAVAIL EDOM EMFILE ENOLINK ENOTTY ETIME
EAFNOSUPPORT EEXIST EMLINK ENOMEM ENXIO ETIMEDOUT
EAGAIN EFAULT EMSGSIZE ENOMSG EOPNOTSUPP ETXTBSY
EALREADY EFBIG ENAMETOOLONG ENOPROTOOPT EOVERFLOW EWOULDBLOCK
EBADF EHOSTUNREACH ENETDOWN ENOSPC EOWNERDEAD EXDEV
EBADMSG EIDRM ENETRESET ENOSR EPERM errno
EBUSY EILSEQ ENETUNREACH ENOSTR EPIPE
ECANCELED EINPROGRESS ENFILE ENOSYS EPROTO
ECHILD EINTR ENOBUFS ENOTCONN EPROTONOSUPPORT
ECONNABORTED EINVAL ENODATA ENOTDIR EPROTOTYPE

19.5 System error support [syserr]

1

This subclause describes components that the standard library and C++ programs may use to report error conditions originating from the operating system or other low-level application program interfaces.

2

Components described in this subclause shall not change the value of errno ([errno]). Implementations should leave the error states provided by other libraries unchanged.

Header <system_error> synopsis

namespace std {
  class error_category;
  const error_category& generic_category() noexcept;
  const error_category& system_category() noexcept;

  class error_code;
  class error_condition;
  class system_error;

  template <class T>
  struct is_error_code_enum : public false_type {};

  template <class T>
  struct is_error_condition_enum : public false_type {};

  enum class errc {
    address_family_not_supported,       // EAFNOSUPPORT
    address_in_use,                     // EADDRINUSE
    address_not_available,              // EADDRNOTAVAIL
    already_connected,                  // EISCONN
    argument_list_too_long,             // E2BIG
    argument_out_of_domain,             // EDOM
    bad_address,                        // EFAULT
    bad_file_descriptor,                // EBADF
    bad_message,                        // EBADMSG
    broken_pipe,                        // EPIPE
    connection_aborted,                 // ECONNABORTED
    connection_already_in_progress,     // EALREADY
    connection_refused,                 // ECONNREFUSED
    connection_reset,                   // ECONNRESET
    cross_device_link,                  // EXDEV
    destination_address_required,       // EDESTADDRREQ
    device_or_resource_busy,            // EBUSY
    directory_not_empty,                // ENOTEMPTY
    executable_format_error,            // ENOEXEC
    file_exists,                        // EEXIST
    file_too_large,                     // EFBIG
    filename_too_long,                  // ENAMETOOLONG
    function_not_supported,             // ENOSYS
    host_unreachable,                   // EHOSTUNREACH
    identifier_removed,                 // EIDRM
    illegal_byte_sequence,              // EILSEQ
    inappropriate_io_control_operation, // ENOTTY
    interrupted,                        // EINTR
    invalid_argument,                   // EINVAL
    invalid_seek,                       // ESPIPE
    io_error,                           // EIO
    is_a_directory,                     // EISDIR
    message_size,                       // EMSGSIZE
    network_down,                       // ENETDOWN
    network_reset,                      // ENETRESET
    network_unreachable,                // ENETUNREACH
    no_buffer_space,                    // ENOBUFS
    no_child_process,                   // ECHILD
    no_link,                            // ENOLINK
    no_lock_available,                  // ENOLCK
    no_message_available,               // ENODATA
    no_message,                         // ENOMSG
    no_protocol_option,                 // ENOPROTOOPT
    no_space_on_device,                 // ENOSPC
    no_stream_resources,                // ENOSR
    no_such_device_or_address,          // ENXIO
    no_such_device,                     // ENODEV
    no_such_file_or_directory,          // ENOENT
    no_such_process,                    // ESRCH
    not_a_directory,                    // ENOTDIR
    not_a_socket,                       // ENOTSOCK
    not_a_stream,                       // ENOSTR
    not_connected,                      // ENOTCONN
    not_enough_memory,                  // ENOMEM
    not_supported,                      // ENOTSUP
    operation_canceled,                 // ECANCELED
    operation_in_progress,              // EINPROGRESS
    operation_not_permitted,            // EPERM
    operation_not_supported,            // EOPNOTSUPP
    operation_would_block,              // EWOULDBLOCK
    owner_dead,                         // EOWNERDEAD
    permission_denied,                  // EACCES
    protocol_error,                     // EPROTO
    protocol_not_supported,             // EPROTONOSUPPORT
    read_only_file_system,              // EROFS
    resource_deadlock_would_occur,      // EDEADLK
    resource_unavailable_try_again,     // EAGAIN
    result_out_of_range,                // ERANGE
    state_not_recoverable,              // ENOTRECOVERABLE
    stream_timeout,                     // ETIME
    text_file_busy,                     // ETXTBSY
    timed_out,                          // ETIMEDOUT
    too_many_files_open_in_system,      // ENFILE
    too_many_files_open,                // EMFILE
    too_many_links,                     // EMLINK
    too_many_symbolic_link_levels,      // ELOOP
    value_too_large,                    // EOVERFLOW
    wrong_protocol_type,                // EPROTOTYPE
  };
  
  template <> struct is_error_condition_enum<errc> : true_type { }

  error_code make_error_code(errc e) noexcept;
  error_condition make_error_condition(errc e) noexcept;

  // [syserr.compare] Comparison operators:
  bool operator==(const error_code& lhs, const error_code& rhs) noexcept;
  bool operator==(const error_code& lhs, const error_condition& rhs) noexcept;
  bool operator==(const error_condition& lhs, const error_code& rhs) noexcept;
  bool operator==(const error_condition& lhs, const error_condition& rhs) noexcept;
  bool operator!=(const error_code& lhs, const error_code& rhs) noexcept;
  bool operator!=(const error_code& lhs, const error_condition& rhs) noexcept;
  bool operator!=(const error_condition& lhs, const error_code& rhs) noexcept;
  bool operator!=(const error_condition& lhs, const error_condition& rhs) noexcept;

  // [syserr.hash] Hash support
  template <class T> struct hash;
  template <> struct hash<error_code>;
}  // namespace std
3

The value of each enum errc constant shall be the same as the value of the <cerrno> macro shown in the above synopsis. Whether or not the <system_error> implementation exposes the <cerrno> macros is unspecified.

4

The is_error_code_enum and is_error_condition_enum may be specialized for user-defined types to indicate that such types are eligible for class error_code and class error_condition automatic conversions, respectively.

19.5.1 Class error_category [syserr.errcat]

19.5.1.1 Class error_category overview [syserr.errcat.overview]

1

The class error_category serves as a base class for types used to identify the source and encoding of a particular category of error code. Classes may be derived from error_category to support categories of errors in addition to those defined in this International Standard. Such classes shall behave as specified in this subclause. [ Note: error_category objects are passed by reference, and two such objects are equal if they have the same address. This means that applications using custom error_category types should create a single object of each such type.  — end note ]

namespace std {
  class error_category {
  public:
    constexpr error_category() noexcept;
    virtual ~error_category();
    error_category(const error_category&) = delete;
    error_category& operator=(const error_category&) = delete;
    virtual const char* name() const noexcept = 0;
    virtual error_condition default_error_condition(int ev) const noexcept;
    virtual bool equivalent(int code, const error_condition& condition) const noexcept;
    virtual bool equivalent(const error_code& code, int condition) const noexcept;
    virtual string message(int ev) const = 0;
    
    bool operator==(const error_category& rhs) const noexcept;
    bool operator!=(const error_category& rhs) const noexcept;
    bool operator<(const error_category& rhs) const noexcept;
  };

  const error_category& generic_category() noexcept;
  const error_category& system_category() noexcept;

}   // namespace std

19.5.1.2 Class error_category virtual members [syserr.errcat.virtuals]

virtual ~error_category();

1

Effects: Destroys an object of class error_category.

virtual const char* name() const noexcept = 0;

2

Returns: A string naming the error category.

virtual error_condition default_error_condition(int ev) const noexcept;

3

Returns: error_condition(ev, *this).

virtual bool equivalent(int code, const error_condition& condition) const noexcept;

4

Returns: default_error_condition(code) == condition.

virtual bool equivalent(const error_code& code, int condition) const noexcept;

5

Returns: *this == code.category() && code.value() == condition.

virtual string message(int ev) const = 0;

6

Returns: A string that describes the error condition denoted by ev.

19.5.1.3 Class error_category non-virtual members [syserr.errcat.nonvirtuals]

constexpr error_category() noexcept;

1

Effects: Constructs an object of class error_category.

bool operator==(const error_category& rhs) const noexcept;

2

Returns: this == &rhs.

bool operator!=(const error_category& rhs) const noexcept;

3

Returns: !(*this == rhs).

bool operator<(const error_category& rhs) const noexcept;

4

Returns: less<const error_category*>()(this, &rhs).

[ Note: less ([comparisons]) provides a total ordering for pointers.  — end note ]

19.5.1.4 Program defined classes derived from error_category [syserr.errcat.derived]

virtual const char* name() const noexcept = 0;

1

Returns: A string naming the error category.

virtual error_condition default_error_condition(int ev) const noexcept;

2

Returns: An object of type error_condition that corresponds to ev.

virtual bool equivalent(int code, const error_condition& condition) const noexcept;

3

Returns: true if, for the category of error represented by *this, code is considered equivalent to condition; otherwise, false.

virtual bool equivalent(const error_code& code, int condition) const noexcept;

4

Returns: true if, for the category of error represented by *this, code is considered equivalent to condition; otherwise, false.

19.5.1.5 Error category objects [syserr.errcat.objects]

const error_category& generic_category() noexcept;

1

Returns: A reference to an object of a type derived from class error_category. All calls to this function shall return references to the same object.

2

Remarks: The object's default_error_condition and equivalent virtual functions shall behave as specified for the class error_category. The object's name virtual function shall return a pointer to the string "generic".

const error_category& system_category() noexcept;

3

Returns: A reference to an object of a type derived from class error_category. All calls to this function shall return references to the same object.

4

Remarks: The object's equivalent virtual functions shall behave as specified for class error_category. The object's name virtual function shall return a pointer to the string "system". The object's default_error_condition virtual function shall behave as follows:

If the argument ev corresponds to a POSIX errno value posv, the function shall return error_condition(posv, generic_category()). Otherwise, the function shall return error_condition(ev, system_category()). What constitutes correspondence for any given operating system is unspecified. [ Note: The number of potential system error codes is large and unbounded, and some may not correspond to any POSIX errno value. Thus implementations are given latitude in determining correspondence.  — end note ]

19.5.2 Class error_code [syserr.errcode]

19.5.2.1 Class error_code overview [syserr.errcode.overview]

1

The class error_code describes an object used to hold error code values, such as those originating from the operating system or other low-level application program interfaces. [ Note: Class error_code is an adjunct to error reporting by exception.  — end note ]

namespace std {
  class error_code {
  public:
    // [syserr.errcode.constructors] constructors:
    error_code() noexcept;
    error_code(int val, const error_category& cat) noexcept;
    template <class ErrorCodeEnum>
      error_code(ErrorCodeEnum e) noexcept;

    // [syserr.errcode.modifiers] modifiers:
    void assign(int val, const error_category& cat) noexcept;
    template <class ErrorCodeEnum>
        error_code& operator=(ErrorCodeEnum e) noexcept;
    void clear() noexcept;

    // [syserr.errcode.observers] observers:
    int value() const noexcept;
    const error_category& category() const noexcept;
    error_condition default_error_condition() const noexcept;
    string message() const;
    explicit operator bool() const noexcept;

  private:
    int val_;                   // exposition only
    const error_category* cat_; // exposition only
  };

  // [syserr.errcode.nonmembers] non-member functions:
  error_code make_error_code(errc e) noexcept;
  bool operator<(const error_code& lhs, const error_code& rhs) noexcept;

  template <class charT, class traits>
    basic_ostream<charT,traits>&
      operator<<(basic_ostream<charT,traits>& os, const error_code& ec);
}   // namespace std

19.5.2.2 Class error_code constructors [syserr.errcode.constructors]

error_code() noexcept;

1

Effects: Constructs an object of type error_code.

2

Postconditions: val_ == 0 and cat_ == &system_category().

error_code(int val, const error_category& cat) noexcept;

3

Effects: Constructs an object of type error_code.

4

Postconditions: val_ == val and cat_ == &cat.

template <class ErrorCodeEnum> error_code(ErrorCodeEnum e) noexcept;

5

Effects: Constructs an object of type error_code.

6

Postconditions: *this == make_error_code(e).

7

Remarks: This constructor shall not participate in overload resolution unless is_error_code_enum<ErrorCodeEnum>::value is true.

19.5.2.3 Class error_code modifiers [syserr.errcode.modifiers]

void assign(int val, const error_category& cat) noexcept;

1

Postconditions: val_ == val and cat_ == &cat.

template <class ErrorCodeEnum> error_code& operator=(ErrorCodeEnum e) noexcept;

2

Postconditions: *this == make_error_code(e).

3

Returns: *this.

4

Remarks: This operator shall not participate in overload resolution unless is_error_code_enum<ErrorCodeEnum>::value is true.

void clear() noexcept;

5

Postconditions: value() == 0 and category() == system_category().

19.5.2.4 Class error_code observers [syserr.errcode.observers]

int value() const noexcept;

1

Returns: val_.

const error_category& category() const noexcept;

2

Returns: *cat_.

error_condition default_error_condition() const noexcept;

3

Returns: category().default_error_condition(value()).

string message() const;

4

Returns: category().message(value()).

explicit operator bool() const noexcept;

5

Returns: value() != 0.

19.5.2.5 Class error_code non-member functions [syserr.errcode.nonmembers]

error_code make_error_code(errc e) noexcept;

1

Returns: error_code(static_cast<int>(e), generic_category()).

bool operator<(const error_code& lhs, const error_code& rhs) noexcept;

2

Returns: lhs.category() < rhs.category() || lhs.category() == rhs.category() && lhs.value() < rhs.value().

template <class charT, class traits> basic_ostream<charT,traits>& operator<<(basic_ostream<charT,traits>& os, const error_code& ec);

3

Effects: os << ec.category().name() << ':' << ec.value().

19.5.3 Class error_condition [syserr.errcondition]

19.5.3.1 Class error_condition overview [syserr.errcondition.overview]

1

The class error_condition describes an object used to hold values identifying error conditions. [ Note: error_condition values are portable abstractions, while error_code values ([syserr.errcode]) are implementation specific.  — end note ]

namespace std {
  class error_condition {
  public:
    // [syserr.errcondition.constructors] constructors:
    error_condition() noexcept;
    error_condition(int val, const error_category& cat) noexcept;
    template <class ErrorConditionEnum>
      error_condition(ErrorConditionEnum e) noexcept;

    // [syserr.errcondition.modifiers] modifiers:
    void assign(int val, const error_category& cat) noexcept;
    template<class ErrorConditionEnum>
        error_condition& operator=(ErrorConditionEnum e) noexcept;
    void clear() noexcept;

    // [syserr.errcondition.observers] observers:
    int value() const noexcept;
    const error_category& category() const noexcept;
    string message() const;
    explicit operator bool() const noexcept;

  private:
    int val_;                   // exposition only
    const error_category* cat_; // exposition only
  };

  // [syserr.errcondition.nonmembers] non-member functions:
  bool operator<(const error_condition& lhs, const error_condition& rhs) noexcept;
} // namespace std

19.5.3.2 Class error_condition constructors [syserr.errcondition.constructors]

error_condition() noexcept;

1

Effects: Constructs an object of type error_condition.

2

Postconditions: val_ == 0 and cat_ == &generic_category().

error_condition(int val, const error_category& cat) noexcept;

3

Effects: Constructs an object of type error_condition.

4

Postconditions: val_ == val and cat_ == &cat.

template <class ErrorConditionEnum> error_condition(ErrorConditionEnum e) noexcept;

5

Effects: Constructs an object of type error_condition.

6

Postcondition: *this == make_error_condition(e).

7

Remarks: This constructor shall not participate in overload resolution unless is_error_condition_enum<ErrorConditionEnum>::value is true.

19.5.3.3 Class error_condition modifiers [syserr.errcondition.modifiers]

void assign(int val, const error_category& cat) noexcept;

1

Postconditions: val_ == val and cat_ == &cat.

template <class ErrorConditionEnum> error_condition& operator=(ErrorConditionEnum e) noexcept;

2

Postcondition: *this == make_error_condition(e).

3

Returns: *this.

4

Remarks: This operator shall not participate in overload resolution unless is_error_condition_enum<ErrorConditionEnum>::value is true.

void clear() noexcept;

Postconditions: value() == 0 and category() == generic_category().

19.5.3.4 Class error_condition observers [syserr.errcondition.observers]

int value() const noexcept;

1

Returns: val_.

const error_category& category() const noexcept;

2

Returns: *cat_.

string message() const;

3

Returns: category().message(value()).

explicit operator bool() const noexcept;

4

Returns: value() != 0.

19.5.3.5 Class error_condition non-member functions [syserr.errcondition.nonmembers]

error_condition make_error_condition(errc e) noexcept;

Returns: error_condition(static_cast<int>(e), generic_category()).

bool operator<(const error_condition& lhs, const error_condition& rhs) noexcept;

1

Returns: lhs.category() < rhs.category() || lhs.category() == rhs.category() &&
lhs.value() < rhs.value().

19.5.4 Comparison operators [syserr.compare]

bool operator==(const error_code& lhs, const error_code& rhs) noexcept;

1

Returns: lhs.category() == rhs.category() && lhs.value() == rhs.value().

bool operator==(const error_code& lhs, const error_condition& rhs) noexcept;

2

Returns: lhs.category().equivalent(lhs.value(), rhs) || rhs.category().equivalent(lhs, rhs.value()).

bool operator==(const error_condition& lhs, const error_code& rhs) noexcept;

3

Returns: rhs.category().equivalent(rhs.value(), lhs) || lhs.category().equivalent(rhs, lhs.value()).

bool operator==(const error_condition& lhs, const error_condition& rhs) noexcept;

4

Returns: lhs.category() == rhs.category() && lhs.value() == rhs.value().

bool operator!=(const error_code& lhs, const error_code& rhs) noexcept; bool operator!=(const error_code& lhs, const error_condition& rhs) noexcept; bool operator!=(const error_condition& lhs, const error_code& rhs) noexcept; bool operator!=(const error_condition& lhs, const error_condition& rhs) noexcept;

5

Returns: !(lhs == rhs).

19.5.5 System error hash support [syserr.hash]

template <> struct hash<error_code>;

1

The template specialization shall meet the requirements of class template hash ([unord.hash]).

19.5.6 Class system_error [syserr.syserr]

19.5.6.1 Class system_error overview [syserr.syserr.overview]

1

The class system_error describes an exception object used to report error conditions that have an associated error code. Such error conditions typically originate from the operating system or other low-level application program interfaces.

2

[ Note: If an error represents an out-of-memory condition, implementations are encouraged to throw an exception object of type bad_alloc [bad.alloc] rather than system_error.  — end note ]

namespace std {
  class system_error : public runtime_error {
  public:
    system_error(error_code ec, const string& what_arg);
    system_error(error_code ec, const char* what_arg);
    system_error(error_code ec);
    system_error(int ev, const error_category& ecat,
        const string& what_arg);
    system_error(int ev, const error_category& ecat,
        const char* what_arg);
    system_error(int ev, const error_category& ecat);
    const error_code& code() const noexcept;
    const char* what() const noexcept;
  };
}   // namespace std

19.5.6.2 Class system_error members [syserr.syserr.members]

system_error(error_code ec, const string& what_arg);

1

Effects: Constructs an object of class system_error.

2

Postconditions: code() == ec.

string(what()).find(what_arg) != string::npos.

system_error(error_code ec, const char* what_arg);

3

Effects: Constructs an object of class system_error.

4

Postconditions: code() == ec.

string(what()).find(what_arg) != string::npos.

system_error(error_code ec);

5

Effects: Constructs an object of class system_error.

6

Postconditions: code() == ec.

system_error(int ev, const error_category& ecat, const string& what_arg);

7

Effects: Constructs an object of class system_error.

8

Postconditions: code() == error_code(ev, ecat).

string(what()).find(what_arg) != string::npos.

system_error(int ev, const error_category& ecat, const char* what_arg);

9

Effects: Constructs an object of class system_error.

10

Postconditions: code() == error_code(ev, ecat).

string(what()).find(what_arg) != string::npos.

system_error(int ev, const error_category& ecat);

11

Effects: Constructs an object of class system_error.

12

Postconditions: code() == error_code(ev, ecat).

const error_code& code() const noexcept;

13

Returns: ec or error_code(ev, ecat), from the constructor, as appropriate.

const char* what() const noexcept;

14

Returns: An ntbs incorporating the arguments supplied in the constructor.

[ Note: The returned NTBS might be the contents of what_arg + ": " + code.message(). — end note ]