sol2/docs/source/api/nested.rst

nested
======


.. code-block:: cpp
	
	template <typename T>
	struct nested {
		T source;
	};


``sol::nested<...>`` is a template class similar to :doc:`sol::as_table<as_table>`, but with the caveat that every :doc:`container type<containers>` within the ``sol::nested`` type will be retrieved as a table from lua. This is helpful when you need to receive C++-style vectors, lists, and maps nested within each other: all of them will be deserialized from lua using table properties rather than anything else.

The `example`_ provides a very in-depth look at both ``sol::as_table<T>`` and ``sol::nested<T>``, and how the two are equivalent.

.. _example: https://github.com/ThePhD/sol2/blob/develop/examples/containers_as_table.cpp
New feature: `nested` getter for complex nested tables, plus docs and example 2017-03-31 02:11:43 +08:00			`nested`
			`======`

this mega commit prepares to fix all of the issues listed in the repository for the past 3 weeks 2017-08-06 07:20:28 +08:00
New feature: `nested` getter for complex nested tables, plus docs and example 2017-03-31 02:11:43 +08:00			`.. code-block:: cpp`

			`template <typename T>`
			`struct nested {`
			`T source;`
			`};`


			``sol::nested<...>`` is a template class similar to :doc:`sol::as_table<as_table>`, but with the caveat that every :doc:`container type<containers>` within the ``sol::nested`` type will be retrieved as a table from lua. This is helpful when you need to receive C++-style vectors, lists, and maps nested within each other: all of them will be deserialized from lua using table properties rather than anything else.

			The `example`_ provides a very in-depth look at both ``sol::as_table<T>`` and ``sol::nested<T>``, and how the two are equivalent.

			`.. _example: https://github.com/ThePhD/sol2/blob/develop/examples/containers_as_table.cpp`