sol::basic_userdata< base_type > Class Template Reference

#include <sol.hpp>

Inheritance diagram for sol::basic_userdata< base_type >:

Public Member Functions
	basic_userdata () noexcept=default
template<typename T , meta::enable< meta::neg< std::is_same< meta::unqualified_t< T >, basic_userdata >>, meta::neg< std::is_same< base_t, stack_reference >>, is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_userdata (T &&r) noexcept
	basic_userdata (const basic_userdata &)=default
	basic_userdata (basic_userdata &&)=default
basic_userdata &	operator= (const basic_userdata &)=default
basic_userdata &	operator= (basic_userdata &&)=default
	basic_userdata (const stack_reference &r)
	basic_userdata (stack_reference &&r)
template<typename T , meta::enable< is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_userdata (lua_State *L, T &&r)
	basic_userdata (lua_State *L, int index=-1)
	basic_userdata (lua_State *L, ref_index index)
Public Member Functions inherited from sol::basic_table_core< top_level, base_type >
	basic_table_core () noexcept=default
	basic_table_core (const basic_table_core &)=default
	basic_table_core (basic_table_core &&)=default
basic_table_core &	operator= (const basic_table_core &)=default
basic_table_core &	operator= (basic_table_core &&)=default
	basic_table_core (const stack_reference &r)
	basic_table_core (stack_reference &&r)
template<typename T , meta::enable_any< is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_table_core (lua_State *L, T &&r)
	basic_table_core (lua_State *L, const new_table &nt)
	basic_table_core (lua_State *L, int index=-1)
	basic_table_core (lua_State *L, ref_index index)
template<typename T , meta::enable< meta::neg< meta::any_same< meta::unqualified_t< T >, basic_table_core >>, meta::neg< std::is_same< base_type, stack_reference >>, meta::neg< std::is_same< lua_nil_t, meta::unqualified_t< T >>>, is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_table_core (T &&r) noexcept
	basic_table_core (lua_nil_t r) noexcept
iterator	begin () const
iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
template<typename... Ret, typename... Keys>
decltype(auto)	get (Keys &&... keys) const
template<typename T , typename Key >
decltype(auto)	get_or (Key &&key, T &&otherwise) const
template<typename T , typename Key , typename D >
decltype(auto)	get_or (Key &&key, D &&otherwise) const
template<typename T , typename... Keys>
decltype(auto)	traverse_get (Keys &&... keys) const
template<typename... Keys>
basic_table_core &	traverse_set (Keys &&... keys)
template<typename... Args>
basic_table_core &	set (Args &&... args)
template<typename... Ret, typename... Keys>
decltype(auto)	raw_get (Keys &&... keys) const
template<typename T , typename Key >
decltype(auto)	raw_get_or (Key &&key, T &&otherwise) const
template<typename T , typename Key , typename D >
decltype(auto)	raw_get_or (Key &&key, D &&otherwise) const
template<typename T , typename... Keys>
decltype(auto)	traverse_raw_get (Keys &&... keys) const
template<typename... Keys>
basic_table_core &	traverse_raw_set (Keys &&... keys)
template<typename... Args>
basic_table_core &	raw_set (Args &&... args)
template<typename T >
basic_table_core &	set_usertype (usertype< T > &user)
template<typename Key , typename T >
basic_table_core &	set_usertype (Key &&key, usertype< T > &user)
template<typename Class , typename... Args>
basic_table_core &	new_usertype (const std::string &name, Args &&... args)
template<typename Class , typename CTor0 , typename... CTor, typename... Args>
basic_table_core &	new_usertype (const std::string &name, Args &&... args)
template<typename Class , typename... CArgs, typename... Args>
basic_table_core &	new_usertype (const std::string &name, constructors< CArgs... > ctor, Args &&... args)
template<typename Class , typename... Args>
basic_table_core &	new_simple_usertype (const std::string &name, Args &&... args)
template<typename Class , typename CTor0 , typename... CTor, typename... Args>
basic_table_core &	new_simple_usertype (const std::string &name, Args &&... args)
template<typename Class , typename... CArgs, typename... Args>
basic_table_core &	new_simple_usertype (const std::string &name, constructors< CArgs... > ctor, Args &&... args)
template<typename Class , typename... Args>
simple_usertype< Class >	create_simple_usertype (Args &&... args)
template<typename Class , typename CTor0 , typename... CTor, typename... Args>
simple_usertype< Class >	create_simple_usertype (Args &&... args)
template<typename Class , typename... CArgs, typename... Args>
simple_usertype< Class >	create_simple_usertype (constructors< CArgs... > ctor, Args &&... args)
template<bool read_only = true, typename... Args>
table	new_enum (const string_view &name, Args &&... args)
template<typename T , bool read_only = true>
table	new_enum (const string_view &name, std::initializer_list< std::pair< string_view, T >> items)
template<typename Fx >
void	for_each (Fx &&fx) const
size_t	size () const
bool	empty () const
template<typename T >
proxy< basic_table_core &, T >	operator[] (T &&key) &
template<typename T >
proxy< const basic_table_core &, T >	operator[] (T &&key) const &
template<typename T >
proxy< basic_table_core, T >	operator[] (T &&key) &&
template<typename Sig , typename Key , typename... Args>
basic_table_core &	set_function (Key &&key, Args &&... args)
template<typename Key , typename... Args>
basic_table_core &	set_function (Key &&key, Args &&... args)
template<typename... Args>
basic_table_core &	add (Args &&... args)
table	create (int narr=0, int nrec=0)
template<typename Key , typename Value , typename... Args>
table	create (int narr, int nrec, Key &&key, Value &&value, Args &&... args)
template<typename Name >
table	create (Name &&name, int narr=0, int nrec=0)
template<typename Name , typename Key , typename Value , typename... Args>
table	create (Name &&name, int narr, int nrec, Key &&key, Value &&value, Args &&... args)
template<typename... Args>
table	create_with (Args &&... args)
template<typename Name , typename... Args>
table	create_named (Name &&name, Args &&... args)
Public Member Functions inherited from sol::basic_object_base< base_type >
	basic_object_base () noexcept=default
	basic_object_base (const basic_object_base &)=default
	basic_object_base (basic_object_base &&)=default
	basic_object_base (T &&arg, Args &&... args)
basic_object_base &	operator= (const basic_object_base &)=default
basic_object_base &	operator= (basic_object_base &&)=default
decltype(auto)	as () const
bool	is () const

Private Types
typedef basic_table< base_type >	base_t

Additional Inherited Members
Public Types inherited from sol::basic_table_core< top_level, base_type >
typedef basic_table_iterator< base_type >	iterator
typedef iterator	const_iterator
Static Public Member Functions inherited from sol::basic_table_core< top_level, base_type >
static table	create (lua_State *L, int narr=0, int nrec=0)
template<typename Key , typename Value , typename... Args>
static table	create (lua_State *L, int narr, int nrec, Key &&key, Value &&value, Args &&... args)
template<typename... Args>
static table	create_with (lua_State *L, Args &&... args)
Protected Member Functions inherited from sol::basic_table_core< top_level, base_type >
	basic_table_core (detail::no_safety_tag, lua_nil_t n)
	basic_table_core (detail::no_safety_tag, lua_State *L, int index)
	basic_table_core (detail::no_safety_tag, lua_State *L, ref_index index)
template<typename T , meta::enable< meta::neg< meta::any_same< meta::unqualified_t< T >, basic_table_core >>, meta::neg< std::is_same< base_type, stack_reference >>, meta::neg< std::is_same< lua_nil_t, meta::unqualified_t< T >>>, is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_table_core (detail::no_safety_tag, T &&r) noexcept
template<typename T , meta::enable< is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_table_core (detail::no_safety_tag, lua_State *L, T &&r) noexcept

Member Typedef Documentation

base_t

template<typename base_type >

typedef basic_table<base_type> sol::basic_userdata< base_type >::base_t

private

Constructor & Destructor Documentation

basic_userdata() [1/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( )

defaultnoexcept

basic_userdata() [2/9]

template<typename base_type >

template<typename T , meta::enable< meta::neg< std::is_same< meta::unqualified_t< T >, basic_userdata >>, meta::neg< std::is_same< base_t, stack_reference >>, is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>

sol::basic_userdata< base_type >::basic_userdata ( T &&  r )

inlinenoexcept

        : base_t(std::forward<T>(r)) {
#if defined(SOL_SAFE_REFERENCES) && SOL_SAFE_REFERENCES
            if (!is_userdata<meta::unqualified_t<T>>::value) {
                auto pp = stack::push_pop(*this);
                type_assert(lua_state(), -1, type::userdata);
            }
#endif // Safety
        }

basic_userdata() [3/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( const basic_userdata< base_type > &  )

default

basic_userdata() [4/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( basic_userdata< base_type > &&  )

default

basic_userdata() [5/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( const stack_reference &  r )

inline

        : basic_userdata(r.lua_state(), r.stack_index()) {
        }

basic_userdata() [6/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( stack_reference &&  r )

inline

        : basic_userdata(r.lua_state(), r.stack_index()) {
        }

basic_userdata() [7/9]

template<typename base_type >

template<typename T , meta::enable< is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>

sol::basic_userdata< base_type >::basic_userdata ( lua_State *  L, T &&  r  )

inline

        : base_t(L, std::forward<T>(r)) {
#if defined(SOL_SAFE_REFERENCES) && SOL_SAFE_REFERENCES
            auto pp = stack::push_pop(*this);
            constructor_handler handler{};
            stack::check<basic_userdata>(L, -1, handler);
#endif // Safety
        }

basic_userdata() [8/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( lua_State *  L, int  index = -1  )

inline

        : base_t(detail::no_safety, L, index) {
#if defined(SOL_SAFE_REFERENCES) && SOL_SAFE_REFERENCES
            constructor_handler handler{};
            stack::check<basic_userdata>(L, index, handler);
#endif // Safety
        }

basic_userdata() [9/9]

template<typename base_type >

sol::basic_userdata< base_type >::basic_userdata ( lua_State *  L, ref_index  index  )

inline

        : base_t(detail::no_safety, L, index) {
#if defined(SOL_SAFE_REFERENCES) && SOL_SAFE_REFERENCES
            auto pp = stack::push_pop(*this);
            constructor_handler handler{};
            stack::check<basic_userdata>(L, -1, handler);
#endif // Safety
        }

Member Function Documentation

operator=() [1/2]

template<typename base_type >

basic_userdata& sol::basic_userdata< base_type >::operator= ( const basic_userdata< base_type > &  )

default

operator=() [2/2]

template<typename base_type >

basic_userdata& sol::basic_userdata< base_type >::operator= ( basic_userdata< base_type > &&  )

default

---

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

• external/sol.hpp