sol2/docs/source/api/yielding.rst

yielding
========
*telling a C++ function to yield its results into Lua*

.. code-block:: cpp

	template <typename F>
	yield_wrapper<F> yielding( F&& f )

``sol::yielding`` is useful for calling C++ functions which need to yield into a Lua coroutine. It is a wrapper around a single argument which is expected to be bound as a function. You can pass it anywhere a regular function can be bound, **except for in usertype definitions**.
add handle for potentially overloaded `size()` definitions (pray it works with noexcept anyhow). 2018-02-23 01:26:46 +08:00			`yielding`
			`========`
			`telling a C++ function to yield its results into Lua`

			`.. code-block:: cpp`

			`template <typename F>`
			`yield_wrapper<F> yielding( F&& f )`

			``sol::yielding`` is useful for calling C++ functions which need to yield into a Lua coroutine. It is a wrapper around a single argument which is expected to be bound as a function. You can pass it anywhere a regular function can be bound, except for in usertype definitions.