sol2/docs/source/api/error.rst

error
=====
*the single error/exception type*


.. code-block:: cpp

	class error : public std::runtime_error {
	public:
		error(const std::string& str): std::runtime_error("lua: error: " + str) {}
	};


.. note::

	Please do not throw this error type yourself. It belongs to the library and we do some information appending at the front.


If an eror is thrown by sol, it is going to be of this type. We use this in a single place: the default ``at_panic`` function we bind on construction of a :ref:`sol::state<set-panic>`. If you turn :doc:`off exceptions<../exceptions>`, the chances of you seeing this error are nil unless you specifically use it to pull errors out of things such as :doc:`sol::protected_function<protected_function>`.

As it derives from ``std::runtime_error``, which derives from ``std::exception``, you can catch it with a ``catch (const std::exception& )`` clause in your try/catch blocks. You can retrieve a string error from Lua (Lua pushes all its errors as string returns) by using this type with any of the get or lookup functions in sol.
The docs are here. 2016-03-12 06:47:15 +08:00			`error`
			`=====`
this mega commit prepares to fix all of the issues listed in the repository for the past 3 weeks 2017-08-06 07:20:28 +08:00			`the single error/exception type`

The docs are here. 2016-03-12 06:47:15 +08:00
			`.. code-block:: cpp`

			`class error : public std::runtime_error {`
			`public:`
add as_container documentation improve exception documentation improve state_view default handlers add SAFE_PROPAGATION defines for compiling C++ as Lua add examples for automatic operator registrations and as_container fix tutorial code change tests to not throw unless absolutely necessary provide synchronization for file writing in tests provide thread safety around thread tests for REQUIRE add ostream automatic support change 5.1 compat to only kick in luaL_loadbufferx and luaL_loadfilex when LuaJIT is version 2.0.1 and lower 2017-08-11 15:24:17 +08:00			`error(const std::string& str): std::runtime_error("lua: error: " + str) {}`
The docs are here. 2016-03-12 06:47:15 +08:00			`};`

add as_container documentation improve exception documentation improve state_view default handlers add SAFE_PROPAGATION defines for compiling C++ as Lua add examples for automatic operator registrations and as_container fix tutorial code change tests to not throw unless absolutely necessary provide synchronization for file writing in tests provide thread safety around thread tests for REQUIRE add ostream automatic support change 5.1 compat to only kick in luaL_loadbufferx and luaL_loadfilex when LuaJIT is version 2.0.1 and lower 2017-08-11 15:24:17 +08:00
			`.. note::`

			`Please do not throw this error type yourself. It belongs to the library and we do some information appending at the front.`


HEAVILY improve the entire infrastructure and documentation along with all the examples 2019-05-22 07:17:31 +08:00			If an eror is thrown by sol, it is going to be of this type. We use this in a single place: the default ``at_panic`` function we bind on construction of a :ref:`sol::state<set-panic>`. If you turn :doc:`off exceptions<../exceptions>`, the chances of you seeing this error are nil unless you specifically use it to pull errors out of things such as :doc:`sol::protected_function<protected_function>`.
The docs are here. 2016-03-12 06:47:15 +08:00
HEAVILY improve the entire infrastructure and documentation along with all the examples 2019-05-22 07:17:31 +08:00			As it derives from ``std::runtime_error``, which derives from ``std::exception``, you can catch it with a ``catch (const std::exception& )`` clause in your try/catch blocks. You can retrieve a string error from Lua (Lua pushes all its errors as string returns) by using this type with any of the get or lookup functions in sol.