Proxy object for associative containers. More...

#include <meta.hpp>

Public Types
using	size_type = std::size_t
	Unsigned integer type.

using	iterator = meta_iterator
	Meta iterator type.

Public Member Functions
	meta_associative_container () noexcept
	Default constructor.

	meta_associative_container (const meta_ctx &area) noexcept
	Context aware constructor.

template<typename Type >
void	rebind (Type &instance) noexcept
	Rebinds a proxy object to an associative container type.

bool	key_only () const noexcept
	Returns true if a container is also key-only, false otherwise.

meta_type	key_type () const noexcept
	Returns the meta key type of a container.

meta_type	mapped_type () const noexcept
	Returns the meta mapped type of a container.

meta_type	value_type () const noexcept
	Returns the meta value type of a container.

size_type	size () const noexcept
	Returns the size of a container.

bool	clear ()
	Clears the content of a container.

bool	reserve (const size_type)
	Reserves storage for at least the given number of elements.

iterator	begin ()
	Returns an iterator to the first element of a container.

iterator	end ()
	Returns an iterator that is past the last element of a container.

bool	insert (meta_any, meta_any)
	Inserts a key-only or key/value element into a container.

size_type	erase (meta_any)
	Removes the specified element from a container.

iterator	find (meta_any)
	Returns an iterator to the element with a given key, if any.

	operator bool () const noexcept
	Returns false if a proxy is invalid, true otherwise.

Detailed Description

Proxy object for associative containers.

Definition at line 100 of file meta.hpp.

Member Typedef Documentation

◆ iterator

using entt::meta_associative_container::iterator = meta_iterator

Meta iterator type.

Definition at line 107 of file meta.hpp.

◆ size_type

using entt::meta_associative_container::size_type = std::size_t

Unsigned integer type.

Definition at line 105 of file meta.hpp.

Constructor & Destructor Documentation

◆ meta_associative_container() [1/2]

entt::meta_associative_container::meta_associative_container ( )

inlinenoexcept

Default constructor.

Definition at line 110 of file meta.hpp.

◆ meta_associative_container() [2/2]

entt::meta_associative_container::meta_associative_container ( const meta_ctx & area )

inlinenoexcept

Context aware constructor.

Parameters

area	The context from which to search for meta types.

Definition at line 117 of file meta.hpp.

Member Function Documentation

◆ begin()

meta_associative_container::iterator entt::meta_associative_container::begin ( )

inline

Returns an iterator to the first element of a container.

Returns: An iterator to the first element of the container.

Definition at line 1938 of file meta.hpp.

◆ clear()

bool entt::meta_associative_container::clear ( )

inline

Clears the content of a container.

Returns: True in case of success, false otherwise.

Definition at line 1928 of file meta.hpp.

◆ end()

meta_associative_container::iterator entt::meta_associative_container::end ( )

inline

Returns an iterator that is past the last element of a container.

Returns: An iterator that is past the last element of the container.

Definition at line 1943 of file meta.hpp.

◆ erase()

meta_associative_container::size_type entt::meta_associative_container::erase ( meta_any key )

inline

Removes the specified element from a container.

Parameters

key	The key of the element to remove.

Returns: A bool denoting whether the removal took place.

Definition at line 1964 of file meta.hpp.

◆ find()

meta_associative_container::iterator entt::meta_associative_container::find ( meta_any key )

inline

Returns an iterator to the element with a given key, if any.

Parameters

key	The key of the element to search.

Returns: An iterator to the element with the given key, if any.

Definition at line 1973 of file meta.hpp.

◆ insert()

bool entt::meta_associative_container::insert	(	meta_any	key,
		meta_any	value = `{}`
	)

inline

Inserts a key-only or key/value element into a container.

Parameters

key	The key of the element to insert.
value	The value of the element to insert, if needed.

Returns: A bool denoting whether the insertion took place.

Definition at line 1953 of file meta.hpp.

◆ key_only()

bool entt::meta_associative_container::key_only ( ) const

inlinenoexcept

Returns true if a container is also key-only, false otherwise.

Returns: True if the associative container is also key-only, false otherwise.

Definition at line 1897 of file meta.hpp.

◆ key_type()

meta_type entt::meta_associative_container::key_type ( ) const

inlinenoexcept

Returns the meta key type of a container.

Returns: The meta key type of the a container.

Definition at line 1905 of file meta.hpp.

◆ mapped_type()

meta_type entt::meta_associative_container::mapped_type ( ) const

inlinenoexcept

Returns the meta mapped type of a container.

Returns: The meta mapped type of the a container.

Definition at line 1913 of file meta.hpp.

◆ operator bool()

entt::meta_associative_container::operator bool ( ) const

inlineexplicitnoexcept

Returns false if a proxy is invalid, true otherwise.

Returns: False if the proxy is invalid, true otherwise.

Definition at line 1981 of file meta.hpp.

◆ rebind()

template<typename Type >

void entt::meta_associative_container::rebind ( Type & instance )

inlinenoexcept

Rebinds a proxy object to an associative container type.

Template Parameters

Type	Type of container to wrap.

Parameters

instance The container to wrap.

Definition at line 126 of file meta.hpp.

◆ reserve()

bool entt::meta_associative_container::reserve ( const size_type sz )

inline

Reserves storage for at least the given number of elements.

Parameters

sz	The new capacity of the container.

Returns: True in case of success, false otherwise.

Definition at line 1933 of file meta.hpp.

◆ size()

meta_associative_container::size_type entt::meta_associative_container::size ( ) const

inlinenoexcept

Returns the size of a container.

Returns: The size of the container.

Definition at line 1923 of file meta.hpp.

◆ value_type()

meta_type entt::meta_associative_container::value_type ( ) const

inlinenoexcept

Returns the meta value type of a container.

Returns: The meta value type of the container.

Definition at line 1918 of file meta.hpp.

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

src/entt/meta/meta.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ iterator

◆ size_type

Constructor & Destructor Documentation

◆ meta_associative_container() [1/2]

◆ meta_associative_container() [2/2]

Member Function Documentation

◆ begin()

◆ clear()

◆ end()

◆ erase()

◆ find()

◆ insert()

◆ key_only()

◆ key_type()

◆ mapped_type()

◆ operator bool()

◆ rebind()

◆ reserve()

◆ size()

◆ value_type()