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