EnTT 3.13.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
entt::meta_sequence_container Class Reference

Proxy object for sequence 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_sequence_container () noexcept
 Default constructor.
 
 meta_sequence_container (const meta_ctx &area) noexcept
 Context aware constructor.
 
template<typename Type >
void rebind (Type &instance) noexcept
 Rebinds a proxy object to a sequence container type.
 
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 resize (const size_type)
 Resizes a container to contain a given number of elements.
 
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.
 
iterator insert (iterator, meta_any)
 Inserts an element at a specified location of a container.
 
iterator erase (iterator)
 Removes a given element from a container.
 
meta_any operator[] (const size_type)
 Returns a reference to the element at a given location of a container (no bounds checking is performed).
 
 operator bool () const noexcept
 Returns false if a proxy is invalid, true otherwise.
 

Detailed Description

Proxy object for sequence containers.

Definition at line 30 of file meta.hpp.

Member Typedef Documentation

◆ iterator

Meta iterator type.

Definition at line 37 of file meta.hpp.

◆ size_type

Unsigned integer type.

Definition at line 35 of file meta.hpp.

Constructor & Destructor Documentation

◆ meta_sequence_container() [1/2]

entt::meta_sequence_container::meta_sequence_container ( )
inlinenoexcept

Default constructor.

Definition at line 40 of file meta.hpp.

◆ meta_sequence_container() [2/2]

entt::meta_sequence_container::meta_sequence_container ( const meta_ctx area)
inlinenoexcept

Context aware constructor.

Parameters
areaThe context from which to search for meta types.

Definition at line 47 of file meta.hpp.

Member Function Documentation

◆ begin()

meta_sequence_container::iterator entt::meta_sequence_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 1836 of file meta.hpp.

◆ clear()

bool entt::meta_sequence_container::clear ( )
inline

Clears the content of a container.

Returns
True in case of success, false otherwise.

Definition at line 1819 of file meta.hpp.

◆ end()

meta_sequence_container::iterator entt::meta_sequence_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 1844 of file meta.hpp.

◆ erase()

meta_sequence_container::iterator entt::meta_sequence_container::erase ( iterator  it)
inline

Removes a given element from a container.

Parameters
itIterator to the element to remove.
Returns
A possibly invalid iterator following the last removed element.

Definition at line 1869 of file meta.hpp.

◆ insert()

meta_sequence_container::iterator entt::meta_sequence_container::insert ( iterator  it,
meta_any  value 
)
inline

Inserts an element at a specified location of a container.

Parameters
itIterator before which the element will be inserted.
valueElement value to insert.
Returns
A possibly invalid iterator to the inserted element.

Definition at line 1854 of file meta.hpp.

◆ operator bool()

entt::meta_sequence_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 1889 of file meta.hpp.

◆ operator[]()

meta_any entt::meta_sequence_container::operator[] ( const size_type  pos)
inline

Returns a reference to the element at a given location of a container (no bounds checking is performed).

Parameters
posThe position of the element to return.
Returns
A reference to the requested element properly wrapped.

Definition at line 1879 of file meta.hpp.

◆ rebind()

template<typename Type >
void entt::meta_sequence_container::rebind ( Type &  instance)
inlinenoexcept

Rebinds a proxy object to a sequence container type.

Template Parameters
TypeType of container to wrap.
Parameters
instanceThe container to wrap.

Definition at line 56 of file meta.hpp.

◆ reserve()

bool entt::meta_sequence_container::reserve ( const size_type  sz)
inline

Reserves storage for at least the given number of elements.

Parameters
szThe new capacity of the container.
Returns
True in case of success, false otherwise.

Definition at line 1828 of file meta.hpp.

◆ resize()

bool entt::meta_sequence_container::resize ( const size_type  sz)
inline

Resizes a container to contain a given number of elements.

Parameters
szThe new size of the container.
Returns
True in case of success, false otherwise.

Definition at line 1811 of file meta.hpp.

◆ size()

meta_sequence_container::size_type entt::meta_sequence_container::size ( ) const
inlinenoexcept

Returns the size of a container.

Returns
The size of the container.

Definition at line 1802 of file meta.hpp.

◆ value_type()

meta_type entt::meta_sequence_container::value_type ( ) const
inlinenoexcept

Returns the meta value type of a container.

Returns
The meta value type of the container.

Definition at line 1794 of file meta.hpp.


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