Namespaces
Variants
Views
Actions

std::is_union

From cppreference.com
< cpp‎ | types
 
 
Metaprogramming library
Type traits
Type categories
(C++11)
(C++14)  
(C++11)
(C++11)
(C++11)
is_union
(C++11)
(C++11)
(C++11)
(C++11)
Type properties
(C++11)
(C++11)
(C++14)
(C++11)
(C++11)(until C++20*)
(C++11)(deprecated in C++20)
(C++11)
Type trait constants
Metafunctions
(C++17)
Supported operations
Relationships and property queries
Type modifications
(C++11)(C++11)(C++11)
Type transformations
(C++11)(deprecated in C++23)
(C++11)(deprecated in C++23)
(C++11)
(C++11)
(C++17)

(C++11)(until C++20*)(C++17)
Compile-time rational arithmetic
Compile-time integer sequences
 
Defined in header <type_traits>
template< class T >
struct is_union;
(since C++11)

std::is_union is a UnaryTypeTrait.

Checks whether T is a union type. Provides the member constant value, which is equal to true if T is a union type. Otherwise, value is equal to false.

If the program adds specializations for std::is_union or std::is_union_v, the behavior is undefined.

Contents

[edit] Template parameters

T - a type to check

[edit] Helper variable template

template< class T >
inline constexpr bool is_union_v = is_union<T>::value;
(since C++17)

Inherited from std::integral_constant

Member constants

value
[static]
true if T is a union type, 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>

[edit] Example

#include <iostream>
#include <type_traits>
 
struct A {};
 
typedef union
{
    int a;
    float b;
} B;
 
struct C { B d; };
 
int main() 
{
    std::cout << std::boolalpha;
    std::cout << std::is_union<A>::value << '\n';
    std::cout << std::is_union<B>::value << '\n';
    std::cout << std::is_union<C>::value << '\n';
    std::cout << std::is_union<int>::value << '\n';
}

Output:

false
true
false
false

[edit] See also

(C++11)
checks if a type is a non-union class type
(class template) [edit]