entt::meta_func Struct Reference

Opaque wrapper for member functions. More...

#include <meta.hpp>

Public Types
using	size_type = typename internal::meta_func_node::size_type
	Unsigned integer type.

Public Member Functions
	meta_func () noexcept=default
	Default constructor.
	meta_func (const meta_ctx &area, const internal::meta_func_node &curr) noexcept
	Context aware constructor for meta objects.
size_type	arity () const noexcept
	Returns the number of arguments accepted by a member function.
bool	is_const () const noexcept
	Indicates whether a member function is constant or not.
bool	is_static () const noexcept
	Indicates whether a member function is static or not.
meta_type	ret () const noexcept
	Returns the return type of a member function.
meta_type	arg (size_type index) const noexcept
	Returns the type of the i-th argument of a member function.
meta_any	invoke (meta_handle instance, meta_any *const args, const size_type sz) const
	Invokes the underlying function, if possible.
template<typename... Args>
meta_any	invoke (meta_handle instance, Args &&...args) const
	Invokes the underlying function, if possible.
meta_range< meta_prop, typename decltype(internal::meta_func_node::prop)::const_iterator >	prop () const noexcept
	Returns a range to visit registered meta properties.
meta_prop	prop (const id_type key) const
	Lookup utility for meta properties.
template<typename Type >
Type	traits () const noexcept
	Returns all meta traits for a given meta object.
meta_custom	custom () const noexcept
	Returns user defined data for a given meta object.
meta_func	next () const
	Returns the next overload of a given function, if any.
	operator bool () const noexcept
	Returns true if an object is valid, false otherwise.
bool	operator== (const meta_func &other) const noexcept
	Checks if two objects refer to the same type.

Detailed Description

Opaque wrapper for member functions.

Definition at line 1007 of file meta.hpp.

Member Typedef Documentation

size_type

using entt::meta_func::size_type = typename internal::meta_func_node::size_type

Unsigned integer type.

Definition at line 1009 of file meta.hpp.

Constructor & Destructor Documentation

meta_func()

entt::meta_func::meta_func ( const meta_ctx & area, const internal::meta_func_node & curr )

inlinenoexcept

Context aware constructor for meta objects.

Parameters

area	The context from which to search for meta types.
curr	The underlying node with which to construct the instance.

Definition at line 1019 of file meta.hpp.

Member Function Documentation

arg()

meta_type entt::meta_func::arg ( size_type index ) const

inlinenoexcept

Returns the type of the i-th argument of a member function.

Parameters

index

Index of the argument of which to return the type.

Returns

The type of the i-th argument of a member function.

Definition at line 1691 of file meta.hpp.

arity()

size_type entt::meta_func::arity ( ) const

inlinenoexcept

Returns the number of arguments accepted by a member function.

Returns

The number of arguments accepted by the member function.

Definition at line 1027 of file meta.hpp.

custom()

meta_custom entt::meta_func::custom ( ) const

inlinenoexcept

Returns user defined data for a given meta object.

Returns

User defined arbitrary data.

Definition at line 1112 of file meta.hpp.

invoke() [1/2]

template<typename... Args>

meta_any entt::meta_func::invoke ( meta_handle instance, Args &&... args ) const

inline

Invokes the underlying function, if possible.

Template Parameters

Args	Types of arguments to use to invoke the function.

Parameters

instance	An opaque instance of the underlying type.
args	Parameters to use to invoke the function.

Returns

A wrapper containing the returned value, if any.

Definition at line 1080 of file meta.hpp.

invoke() [2/2]

meta_any entt::meta_func::invoke ( meta_handle instance, meta_any *const args, const size_type sz ) const

inline

Invokes the underlying function, if possible.

Parameters

instance	An opaque instance of the underlying type.
args	Parameters to use to invoke the function.
sz	Number of parameters to use to invoke the function.

Returns

A wrapper containing the returned value, if any.

Definition at line 1067 of file meta.hpp.

is_const()

bool entt::meta_func::is_const ( ) const

inlinenoexcept

Indicates whether a member function is constant or not.

Returns

True if the member function is constant, false otherwise.

Definition at line 1035 of file meta.hpp.

is_static()

bool entt::meta_func::is_static ( ) const

inlinenoexcept

Indicates whether a member function is static or not.

Returns

True if the member function is static, false otherwise.

Definition at line 1043 of file meta.hpp.

next()

meta_func entt::meta_func::next ( ) const

inline

Returns the next overload of a given function, if any.

Returns

The next overload of the given function, if any.

Definition at line 1120 of file meta.hpp.

operator bool()

entt::meta_func::operator bool ( ) const

inlineexplicitnoexcept

Returns true if an object is valid, false otherwise.

Returns

True if the object is valid, false otherwise.

Definition at line 1128 of file meta.hpp.

operator==()

bool entt::meta_func::operator== ( const meta_func & other ) const

inlinenoexcept

Checks if two objects refer to the same type.

Parameters

other

The object with which to compare.

Returns

True if the objects refer to the same type, false otherwise.

Definition at line 1133 of file meta.hpp.

prop() [1/2]

meta_range< meta_prop, typename decltype(internal::meta_func_node::prop)::const_iterator > entt::meta_func::prop ( ) const

inlinenoexcept

Returns a range to visit registered meta properties.

Returns

An iterable range to visit registered meta properties.

Definition at line 1086 of file meta.hpp.

prop() [2/2]

meta_prop entt::meta_func::prop ( const id_type key ) const

inline

Lookup utility for meta properties.

Parameters

key	The key to use to search for a property.

Returns

The registered meta property for the given key, if any.

Definition at line 1095 of file meta.hpp.

ret()

meta_type entt::meta_func::ret ( ) const

inlinenoexcept

Returns the return type of a member function.

Returns

The return type of the member function.

Definition at line 1687 of file meta.hpp.

traits()

template<typename Type >

Type entt::meta_func::traits ( ) const

inlinenoexcept

Returns all meta traits for a given meta object.

Template Parameters

Type	The type to convert the meta traits to.

Returns

The registered meta traits, if any.

Definition at line 1107 of file meta.hpp.

---

The documentation for this struct was generated from the following file:

• src/entt/meta/meta.hpp