diff options
Diffstat (limited to 'lib/sol2/docs/source/api/as_args.rst')
| -rw-r--r-- | lib/sol2/docs/source/api/as_args.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/as_args.rst b/lib/sol2/docs/source/api/as_args.rst new file mode 100644 index 0000000..36fe5c1 --- /dev/null +++ b/lib/sol2/docs/source/api/as_args.rst @@ -0,0 +1,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 |