sol::basic_environment< base_type > Struct Template Reference

#include <forward.hpp>

Inheritance diagram for sol::basic_environment< base_type >:

Public Member Functions
	basic_environment () noexcept=default
	basic_environment (const basic_environment &)=default
	basic_environment (basic_environment &&)=default
	basic_environment (const stack_reference &r)
	basic_environment (stack_reference &&r)
	basic_environment (lua_State *L, new_table nt)
template<bool b>
	basic_environment (lua_State *L, new_table t, const basic_reference< b > &fallback)
	basic_environment (env_key_t, const stack_reference &extraction_target)
template<bool b>
	basic_environment (env_key_t, const basic_reference< b > &extraction_target)
	basic_environment (lua_State *L, int index=-1)
	basic_environment (lua_State *L, ref_index index)
template<typename T , meta::enable< meta::neg< meta::any_same< meta::unqualified_t< T >, basic_environment >>, 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_environment (T &&r) noexcept
	basic_environment (lua_nil_t r) noexcept
template<typename T , meta::enable< is_lua_reference< meta::unqualified_t< T >>> = meta::enabler>
	basic_environment (lua_State *L, T &&r) noexcept
basic_environment &	operator= (const basic_environment &)=default
basic_environment &	operator= (basic_environment &&)=default
template<typename T >
bool	set_on (const T &target) const
Public Member Functions inherited from sol::basic_table_core< top_level, ref_t >
template<typename... Args>
basic_table_core &	add (Args &&... args)
	basic_table_core () noexcept=default
	basic_table_core (const basic_table_core &)=default
	basic_table_core (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< ref_t, 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
	basic_table_core (lua_State *L, global_tag_t t) noexcept
iterator	begin () const
const_iterator	cbegin () const
const_iterator	cend () const
void	clear ()
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 Name , typename... Args>
table	create_named (Name &&name, Args &&... args)
template<typename... Args>
table	create_with (Args &&... args)
bool	empty () const
iterator	end () const
template<typename Key = object, typename Value = object, typename Fx >
void	for_each (Fx &&fx) 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<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 Class , typename Key >
usertype< Class >	new_usertype (Key &&key)
template<typename Class , typename Key , automagic_flags enrollment_flags>
usertype< Class >	new_usertype (Key &&key, constant_automagic_enrollments< enrollment_flags > enrollment)
template<typename Class , typename Key >
usertype< Class >	new_usertype (Key &&key, automagic_enrollments enrollment)
template<typename Class , typename Key , typename Arg , typename... Args, typename = std::enable_if_t<!std::is_base_of_v<automagic_enrollments, meta::unqualified_t<Arg>>>>
usertype< Class >	new_usertype (Key &&key, Arg &&arg, Args &&... args)
basic_table_core &	operator= (const basic_table_core &)=default
basic_table_core &	operator= (basic_table_core &&)=default
template<typename T >
auto	operator[] (T &&key) &
template<typename T >
auto	operator[] (T &&key) const &
template<typename T >
auto	operator[] (T &&key) &&
basic_pairs_range< basic_table_core >	pairs () noexcept
basic_pairs_range< const basic_table_core >	pairs () const noexcept
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... Args>
basic_table_core &	raw_set (Args &&... args)
template<typename... Args>
basic_table_core &	set (Args &&... args)
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)
size_t	size () const
template<typename T , typename... Keys>
decltype(auto)	traverse_get (Keys &&... keys) 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... Keys>
basic_table_core &	traverse_set (Keys &&... keys)
Public Member Functions inherited from sol::basic_object< ref_t >
	basic_object () noexcept=default
	basic_object (T &&r)
	basic_object (lua_State *L_, T &&r)
	basic_object (lua_State *L_, global_tag_t t)
	basic_object (lua_nil_t r)
	basic_object (const basic_object &)=default
	basic_object (basic_object &&)=default
	basic_object (const stack_reference &r) noexcept
	basic_object (stack_reference &&r) noexcept
	basic_object (const proxy_base< Super > &r) noexcept
	basic_object (proxy_base< Super > &&r) noexcept
	basic_object (lua_State *L_, lua_nil_t r) noexcept
	basic_object (lua_State *L_, int index_=-1) noexcept
	basic_object (lua_State *L_, absolute_index index_) noexcept
	basic_object (lua_State *L_, raw_index index_) noexcept
	basic_object (lua_State *L_, ref_index index_) noexcept
	basic_object (lua_State *L_, in_place_type_t< T >, Args &&... args) noexcept
	basic_object (lua_State *L_, in_place_t, T &&arg, Args &&... args) noexcept
basic_object &	operator= (const basic_object &)=default
basic_object &	operator= (basic_object &&)=default
basic_object &	operator= (const ref_t &b)
basic_object &	operator= (ref_t &&b)
basic_object &	operator= (const proxy_base< Super > &r)
basic_object &	operator= (proxy_base< Super > &&r)
Public Member Functions inherited from sol::basic_object_base< ref_t >
template<typename T >
decltype(auto)	as () const
	basic_object_base () noexcept=default
	basic_object_base (const basic_object_base &)=default
	basic_object_base (basic_object_base &&)=default
template<typename T , typename... Args, meta::enable< meta::neg< std::is_same< meta::unqualified_t< T >, basic_object_base >>> = meta::enabler>
	basic_object_base (T &&arg, Args &&... args)
template<typename T >
bool	is () const
basic_object_base &	operator= (const basic_object_base &)=default
basic_object_base &	operator= (basic_object_base &&)=default

Private Types
typedef basic_table< base_type >	base_t

Additional Inherited Members
Public Types inherited from sol::basic_table_core< top_level, ref_t >
using	const_iterator = iterator
using	iterator = basic_table_iterator< ref_t >
Static Public Member Functions inherited from sol::basic_table_core< top_level, ref_t >
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, ref_t >
	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< ref_t, 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
Protected Member Functions inherited from sol::basic_object< ref_t >
	basic_object (detail::no_safety_tag, lua_nil_t n)
	basic_object (detail::no_safety_tag, lua_State *L_, int index_)
	basic_object (detail::no_safety_tag, lua_State *L_, ref_index index_)
	basic_object (detail::no_safety_tag, T &&r) noexcept
	basic_object (detail::no_safety_tag, lua_State *L_, T &&r) noexcept

Detailed Description

template<typename base_type>
struct sol::basic_environment< base_type >

Definition at line 1151 of file forward.hpp.

Member Typedef Documentation

base_t

template<typename base_type>

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

private

Definition at line 26575 of file sol.hpp.

Constructor & Destructor Documentation

basic_environment() [1/14]

template<typename base_type>

sol::basic_environment< base_type >::basic_environment ( )

defaultnoexcept

basic_environment() [2/14]

template<typename base_type>

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

default

basic_environment() [3/14]

template<typename base_type>

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

default

basic_environment() [4/14]

template<typename base_type>

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

inline

Definition at line 26585 of file sol.hpp.

basic_environment() [5/14]

template<typename base_type>

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

inline

Definition at line 26587 of file sol.hpp.

basic_environment() [6/14]

template<typename base_type>

sol::basic_environment< base_type >::basic_environment ( lua_State *  L, new_table  nt  )

inline

Definition at line 26590 of file sol.hpp.

basic_environment() [7/14]

template<typename base_type>

template<bool b>

sol::basic_environment< base_type >::basic_environment ( lua_State *  L, new_table  t, const basic_reference< b > &  fallback  )

inline

Definition at line 26593 of file sol.hpp.

basic_environment() [8/14]

template<typename base_type>

sol::basic_environment< base_type >::basic_environment ( env_key_t  , const stack_reference &  extraction_target  )

inline

Definition at line 26600 of file sol.hpp.

basic_environment() [9/14]

template<typename base_type>

template<bool b>

sol::basic_environment< base_type >::basic_environment ( env_key_t  , const basic_reference< b > &  extraction_target  )

inline

Definition at line 26609 of file sol.hpp.

basic_environment() [10/14]

template<typename base_type>

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

inline

Definition at line 26617 of file sol.hpp.

basic_environment() [11/14]

template<typename base_type>

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

inline

Definition at line 26623 of file sol.hpp.

basic_environment() [12/14]

template<typename base_type>

template<typename T , meta::enable< meta::neg< meta::any_same< meta::unqualified_t< T >, basic_environment >>, 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>

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

inlinenoexcept

Definition at line 26633 of file sol.hpp.

basic_environment() [13/14]

template<typename base_type>

sol::basic_environment< base_type >::basic_environment ( lua_nil_t  r )

inlinenoexcept

Definition at line 26642 of file sol.hpp.

basic_environment() [14/14]

template<typename base_type>

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

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

inlinenoexcept

Definition at line 26646 of file sol.hpp.

Member Function Documentation

operator=() [1/2]

template<typename base_type>

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

default

operator=() [2/2]

template<typename base_type>

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

default

set_on()

template<typename base_type>

template<typename T >

bool sol::basic_environment< base_type >::set_on ( const T &  target ) const

inline

Definition at line 26657 of file sol.hpp.

---

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

• forward.hpp
• sol.hpp