sol2/documentation/source/api/tie.rst

12 lines
490 B
ReStructuredText
Raw Normal View History

tie
===
*improved version of std::tie*
`std::tie()`_ does not work well with :doc:`sol::function<function>`'s ``sol::function_result`` returns. Use ``sol::tie`` instead. Because they're both named `tie`, you'll need to be explicit when you use sol's by naming it with the namespace (``sol::tie``), even with a ``using namespace sol;``. Here's an example:
.. literalinclude:: ../../../examples/source/tie.cpp
:linenos:
.. _std::tie(): http://en.cppreference.com/w/cpp/utility/tuple/tie