sol2/docs/source/api/protect.rst

protect
=======
*routine to mark a function / variable as requiring safety*


.. code-block:: cpp
	
	template <typename T>
	auto protect( T&& value );

``sol::protect( my_func )`` allows you to protect a function call or member variable call when it is being set to Lua. It can be used with usertypes or when just setting a function into Sol. Below is an example that demonstrates that a call that would normally not error without :doc:`Safety features turned on<../safety>` that instead errors and makes the Lua safety-call wrapper ``pcall`` fail:

.. literalinclude:: ../../../examples/source/protect.cpp
	:linenos:
protect could use some additional optimizations for space, but I'm kinna tired. 2016-07-09 15:43:51 +08:00			`protect`
			`=======`
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			`routine to mark a function / variable as requiring safety`

protect could use some additional optimizations for space, but I'm kinna tired. 2016-07-09 15:43:51 +08:00
			`.. code-block:: cpp`

			`template <typename T>`
			`auto protect( T&& value );`

[ci skip] look at myyy docs, my docs are amaaazi- Pfff no they're not. They're not amazing. They're crap. Just. Like. Me. 2016-08-26 03:04:35 +08:00			``sol::protect( my_func )`` allows you to protect a function call or member variable call when it is being set to Lua. It can be used with usertypes or when just setting a function into Sol. Below is an example that demonstrates that a call that would normally not error without :doc:`Safety features turned on<../safety>` that instead errors and makes the Lua safety-call wrapper ``pcall`` fail:
protect could use some additional optimizations for space, but I'm kinna tired. 2016-07-09 15:43:51 +08:00
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/protect.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			`:linenos:`