aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/protect.rst
diff options
context:
space:
mode:
authorAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
committerAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
commitdc2493e7525bb7633f697ef10f72b72b46222249 (patch)
tree9816755219e65d3f47fdce81c78f3736a7ddb8ab /lib/sol2/docs/source/api/protect.rst
parent9d2b31797d0cfd130802b69261df2cd402e39b49 (diff)
Forget what I said, I just need to change git attributes to mark for vendor
Diffstat (limited to 'lib/sol2/docs/source/api/protect.rst')
-rw-r--r--lib/sol2/docs/source/api/protect.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/protect.rst b/lib/sol2/docs/source/api/protect.rst
new file mode 100644
index 0000000..b7fad2d
--- /dev/null
+++ b/lib/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: