sol2/docs/source/api/readonly.rst

readonly
========
Routine to mark a member variable as read-only
----------------------------------------------

.. code-block:: cpp
	
	template <typename T>
	auto readonly( T&& value );

The goal of read-only is to protect a variable set on a usertype or a function. Simply wrap it around a member variable, e.g. ``sol::readonly( &my_class::my_member_variable )`` in the appropriate place to use it. If someone tries to set it, it will throw an error.
protect could use some additional optimizations for space, but I'm kinna tired. 2016-07-09 15:43:51 +08:00			`readonly`
			`========`
			`Routine to mark a member variable as read-only`
			`----------------------------------------------`

			`.. code-block:: cpp`

			`template <typename T>`
			`auto readonly( T&& value );`

[ci skip] look at myyy docs, my docs are amaaazi- Pfff no they're not. They're not amazing. They're crap. Just. Like. Me. 2016-08-26 03:04:35 +08:00			The goal of read-only is to protect a variable set on a usertype or a function. Simply wrap it around a member variable, e.g. ``sol::readonly( &my_class::my_member_variable )`` in the appropriate place to use it. If someone tries to set it, it will throw an error.