File: as_args.rst

package info (click to toggle)
sol2 3.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 23,096 kB
  • sloc: cpp: 43,816; ansic: 1,018; python: 356; sh: 288; makefile: 202
file content (25 lines) | stat: -rw-r--r-- 835 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
	:name: args-from-container
	: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