as_args¶
turn an iterable argument into multiple arguments
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:
args_from_container.cpp¶
1#define SOL_ALL_SAFETIES_ON 1
2#include <sol/sol.hpp>
3
4#include <iostream>
5#include <vector>
6#include <set>
7
8int main(int, const char*[]) {
9
10 std::cout << "=== args_from_container ===" << std::endl;
11
12 sol::state lua;
13 lua.open_libraries();
14
15 lua.script("function f (a, b, c, d) print(a, b, c, d) end");
16
17 sol::function f = lua["f"];
18
19 std::vector<int> v2 { 3, 4 };
20 f(1, 2, sol::as_args(v2));
21
22 std::set<int> v4 { 3, 1, 2, 4 };
23 f(sol::as_args(v4));
24
25 int v3[] = { 2, 3, 4 };
26 f(1, sol::as_args(v3));
27
28 std::cout << std::endl;
29
30 return 0;
31}
It is basically implemented as a one-way customization point. For more information about customization points, see the tutorial on how to customize sol to work with your types.