diff options
| author | Clyne Sullivan <clyne@bitgloo.com> | 2022-11-15 07:35:07 -0500 |
|---|---|---|
| committer | Clyne Sullivan <clyne@bitgloo.com> | 2022-11-15 07:35:07 -0500 |
| commit | a056c15dd3781b4f6bb89fdd738b14cafc00cd85 (patch) | |
| tree | 1775a5913c7bc87563b6b4a29c63514cf15b4185 /lib/sol2/docs/source/api/protect.rst | |
| parent | 1405d648b6264cfda7c46f5b251258335abaee83 (diff) | |
| parent | 57013add5b7c524086272be7d395f9ec5109bde2 (diff) | |
merge branch lib-cleanup into ui
Diffstat (limited to 'lib/sol2/docs/source/api/protect.rst')
| -rw-r--r-- | lib/sol2/docs/source/api/protect.rst | 14 |
1 files changed, 0 insertions, 14 deletions
diff --git a/lib/sol2/docs/source/api/protect.rst b/lib/sol2/docs/source/api/protect.rst deleted file mode 100644 index b7fad2d..0000000 --- a/lib/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: |