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
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#define SOL_ALL_SAFETIES_ON 1
#include <sol/sol.hpp>

#include <iostream>
#include <vector>
#include <set>

int main(int , const char*[]) {
	
	std::cout << "=== args_from_container ===" << std::endl;

	sol::state lua;
	lua.open_libraries();

	lua.script("function f (a, b, c, d) print(a, b, c, d) end");

	sol::function f = lua["f"];

	std::vector<int> v2{ 3, 4 };
	f(1, 2, sol::as_args(v2));

	std::set<int> v4{ 3, 1, 2, 4 };
	f(sol::as_args(v4));

	int v3[] = { 2, 3, 4 };
	f(1, sol::as_args(v3));

	std::cout << std::endl;

	return 0;
}

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.