diff options
author | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:45:36 -0400 |
---|---|---|
committer | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:45:36 -0400 |
commit | dc2493e7525bb7633f697ef10f72b72b46222249 (patch) | |
tree | 9816755219e65d3f47fdce81c78f3736a7ddb8ab /deps/sol2/docs/source/api/protect.rst | |
parent | 9d2b31797d0cfd130802b69261df2cd402e39b49 (diff) |
Forget what I said, I just need to change git attributes to mark for vendor
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: |