1
0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
sol2/docs/source/api/protect.rst

15 lines
619 B
ReStructuredText
Raw Normal View History

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: