New upstream version 4.26upstream/4.26upstream

1 files changed, 22 insertions, 0 deletions

diff --git a/doc/scope.rst b/doc/scope.rst
new file mode 100644
index 0000000..84ad69b
--- /dev/null
+++ b/doc/scope.rst
@@ -0,0 +1,22 @@
+============
+Scope guards
+============
+
+``scope_exit``
+==============
+
+scope_exit creates an object that runs a predefined function when a scope ends.
+This is useful for augmenting C APIs with something of a destructor without
+wrapping the stuff in an explicit class of its own. For instance,
+
+.. code-block:: c++
+
+	#include <libHX/option.h>
+	#include <libHX/scope.hpp>
+	int main() {
+		auto fa = HXformat_init();
+		if (fa == nullptr)
+			return 0;
+		auto cleanup_fa = HX::make_scope_exit([&]() { HXformat_free(fa); });
+		HXformat_add(fa, "foo", "bar", HXTYPE_STRING);
+	}