sol2/docs/source/api/as_args.rst

as_args
=======
*turn an iterable argument into multiple arguments*


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

	template <typename T>
	as_args_t<T> as_args( T&& );


``sol::as_args`` is a function that that takes an iterable and turns it into multiple arguments to a function call. It forwards its arguments, and is meant to be used as shown below:


.. literalinclude:: ../../../examples/source/args_from_container.cpp
	:caption: args_from_container.cpp
	:linenos:

It is basically implemented as a `one-way customization point`_. For more information about customization points, see the :doc:`tutorial on how to customize sol to work with your types<../tutorial/customization>`.

.. _one-way customization point: https://github.com/ThePhD/sol2/blob/develop/sol/as_args.hpp
as_args and threading API cleanliness. 2016-11-27 02:58:06 +08:00			`as_args`
			`=======`
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			`turn an iterable argument into multiple arguments`

as_args and threading API cleanliness. 2016-11-27 02:58:06 +08:00
			`.. code-block:: cpp`

			`template <typename T>`
C++17 additions: std::variant, string_views of all types, checker for if we have the right version added variadic_results, to return a variable number of arguments to Lua added variadic_results and as_results added improved function examples (for multiple results and split overloading out) added tests for variadics added tests for C++17 utilities added a forwarding header added a specific `unsafe_function` header added and improved documetation pages 2017-07-10 00:00:57 +08:00			`struct as_args_t { ... };`
as_args and threading API cleanliness. 2016-11-27 02:58:06 +08:00
			`template <typename T>`
			`as_args_t<T> as_args( T&& );`


			``sol::as_args`` is a function that that takes an iterable and turns it into multiple arguments to a function call. It forwards its arguments, and is meant to be used as shown below:


fix up CMake files once more, and hopefully prepare for a new test coverage paradigm notably, test normal + single + generated + Lua 5.3.5 only once, then only run the runtime_test and compile_test for normal for all other permutations to help increase text matrix throughput 2018-12-27 15:17:25 +08:00			`.. literalinclude:: ../../../examples/source/args_from_container.cpp`
prepare for new usertype change how type T is gleaned from destructors and constructors in case of new syntax add a hell of a lot more examples, update and clean documentation 2018-03-16 05:16:28 +08:00			`:caption: args_from_container.cpp`
			`:linenos:`
[ci skip] as_args docs 2016-11-27 03:04:44 +08:00
HEAVILY improve the entire infrastructure and documentation along with all the examples 2019-05-22 07:17:31 +08:00			It is basically implemented as a `one-way customization point`_. For more information about customization points, see the :doc:`tutorial on how to customize sol to work with your types<../tutorial/customization>`.
[ci skip] as_args docs 2016-11-27 03:04:44 +08:00
			`.. _one-way customization point: https://github.com/ThePhD/sol2/blob/develop/sol/as_args.hpp`