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, 0 insertions, 14 deletions
diff --git a/deps/sol2/docs/source/api/protect.rst b/deps/sol2/docs/source/api/protect.rst deleted file mode 100644 index b7fad2d..0000000 --- a/deps/sol2/docs/source/api/protect.rst +++ /dev/null @@ -1,14 +0,0 @@ -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: |