Scroll to navigation

std::is_invocable,std::is_invocable_r,std::is_nothrow_invocable,(3) C++ Standard Libary std::is_invocable,std::is_invocable_r,std::is_nothrow_invocable,(3)

NAME

std::is_invocable,std::is_invocable_r,std::is_nothrow_invocable, - std::is_invocable,std::is_invocable_r,std::is_nothrow_invocable,

Synopsis


Defined in header <type_traits>
template< class Fn, class... ArgTypes > (1) (since C++17)
struct is_invocable;
template< class R, class Fn, class... ArgTypes > (2) (since C++17)
struct is_invocable_r;
template< class Fn, class... ArgTypes > (3) (since C++17)
struct is_nothrow_invocable;
template< class R, class Fn, class... ArgTypes > (4) (since C++17)
struct is_nothrow_invocable_r;


1) Determines whether INVOKE(std::declval<Fn>(), std::declval<ArgTypes>()...) is
well formed when treated as an unevaluated operand.
2) Determines whether INVOKE<R>(std::declval<Fn>(), std::declval<ArgTypes>()...) is
well formed when treated as an unevaluated operand.
3) Determines whether INVOKE(std::declval<Fn>(), std::declval<ArgTypes>()...) is
well formed when treated as an unevaluated operand, and is known not to throw any
exceptions.
4) Determines whether INVOKE<R>(std::declval<Fn>(), std::declval<ArgTypes>()...) is
well formed when treated as an unevaluated operand, and is known not to throw any
exceptions.


If Fn, R or any type in the parameter pack ArgTypes is not a complete type,
(possibly cv-qualified) void, or an array of unknown bound, the behavior is
undefined.


If an instantiation of a template above depends, directly or indirectly, on an
incomplete type, and that instantiation could yield a different result if that type
were hypothetically completed, the behavior is undefined.


If the program adds specializations for any of the templates described on this page,
the behavior is undefined.

Member constants


true if (for overload (1)) INVOKE(std::declval<Fn>(),
value std::declval<ArgTypes>()...) is well formed when treated as an unevaluated
[static] operand, false otherwise
(public static member constant)

Member functions


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

Member types


Type Definition
value_type bool
type std::integral_constant<bool, value>

Notes


Feature-test macro Value Std Feature
__cpp_lib_is_invocable 201703L (C++17) std::is_invocable, std::invoke_result

Examples

// Run this code


#include <type_traits>


auto func2(char) -> int (*)()
{
return nullptr;
}


int main()
{
static_assert(std::is_invocable_v<int()>);
static_assert(not std::is_invocable_v<int(), int>);
static_assert(std::is_invocable_r_v<int, int()>);
static_assert(not std::is_invocable_r_v<int*, int()>);
static_assert(std::is_invocable_r_v<void, void(int), int>);
static_assert(not std::is_invocable_r_v<void, void(int), void>);
static_assert(std::is_invocable_r_v<int(*)(), decltype(func2), char>);
static_assert(not std::is_invocable_r_v<int(*)(), decltype(func2), void>);
}

See also


invoke invokes any Callable object with given arguments
invoke_r and possibility to specify return type
(C++17) (since C++23)
(C++23) (function template)
result_of deduces the result type of invoking a callable object with
invoke_result a set of arguments
(C++11)(removed in C++20) (class template)
(C++17)
declval obtains a reference to its argument for use in unevaluated
(C++11) context
(function template)
invocable specifies that a callable type can be invoked with a given
regular_invocable set of argument types
(C++20) (concept)

2024.06.10 http://cppreference.com