Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/error/error code/is error code enum"

From cppreference.com
< cpp‎ | error‎ | error code
m (link to zh)
m (-`inline`, +example.)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{cpp/title|is_error_code_enum}}
 
{{cpp/title|is_error_code_enum}}
 
{{cpp/error/error_code/navbar}}
 
{{cpp/error/error_code/navbar}}
{{dcl begin}}
+
{{ddcl|header=system_error|since=c++11|
{{dcl header | system_error}}
+
{{dcl | since=c++11 | 1=
+
 
template< class T >
 
template< class T >
 
struct is_error_code_enum;
 
struct is_error_code_enum;
 
}}
 
}}
{{dcl end}}
 
  
If {{tt|T}} is an error code enumeration, this template provides the member constant {{c|value}} equal {{c|true}}. For any other type, {{tt|value}} is {{c|false}}.
+
If {{tt|T}} is an error code enumeration (such as {{lc|std::io_errc}} and {{lc|std::future_errc}}), this template provides the member constant {{c|value}} equal {{c|true}}. For any other type, {{c|value}} is {{c|false}}.
  
This template may be specialized for a user-defined type to indicate that the type is eligible for {{lc|std::error_code}} and {{lc|std::error_condition}} automatic conversions.
+
This template may be specialized for a {{lsd|cpp/language/type#Program-defined type}} to indicate that the type is eligible for {{lc|std::error_code}} implicit conversion.
  
The following classes of the standard library are an error code enum:
+
===Helper variable template===
* {{lc|std::io_errc}}
+
{{ddcl|since=c++17|1=
* {{lc|std::future_errc}}.
+
 
+
=== Helper variable template ===
+
{{ddcl | since=c++17 | 1=
+
 
template< class T >
 
template< class T >
inline constexpr bool is_error_code_enum_v = is_error_code_enum<T>::value;
+
constexpr bool is_error_code_enum_v = is_error_code_enum<T>::value;
 
}}
 
}}
  
{{cpp/types/integral_constant/inherit | {{tt|T}} is an error code enum}}
+
{{cpp/types/integral_constant/inherit|{{tt|T}} is an error code enum}}
 +
 
 +
{{example
 +
|code=
 +
#include <ios>
 +
#include <system_error>
 +
 
 +
static_assert(std::is_error_code_enum_v<decltype(std::io_errc::stream)>);
 +
static_assert(!std::is_error_code_enum_v<std::error_category>);
 +
 
 +
int main() {}
 +
}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
{{dsc inc | cpp/error/error_condition/dsc is_error_condition_enum}}
+
{{dsc inc|cpp/error/error_condition/dsc is_error_condition_enum}}
 
+
 
{{dsc end}}
 
{{dsc end}}
  
{{langlinks|zh}}
+
{{langlinks|es|ja|ru|zh}}

Latest revision as of 08:51, 24 September 2024

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
 
 
Defined in header <system_error>
template< class T >
struct is_error_code_enum;
(since C++11)

If T is an error code enumeration (such as std::io_errc and std::future_errc), this template provides the member constant value equal true. For any other type, value is false.

This template may be specialized for a program-defined type to indicate that the type is eligible for std::error_code implicit conversion.

Contents

[edit] Helper variable template

template< class T >
constexpr bool is_error_code_enum_v = is_error_code_enum<T>::value;
(since C++17)

Inherited from std::integral_constant

Member constants

value
[static]
true if T is an error code enum, false otherwise
(public static member constant)

Member functions

operator bool
converts the object to bool, returns value
(public member function)
operator()
(C++14)
returns value
(public member function)

Member types

Type Definition
value_type bool
type std::integral_constant<bool, value>
#include <ios>
#include <system_error>
 
static_assert(std::is_error_code_enum_v<decltype(std::io_errc::stream)>);
static_assert(!std::is_error_code_enum_v<std::error_category>);
 
int main() {}

[edit] See also

identifies an enumeration as an std::error_condition
(class template) [edit]