aboutsummaryrefslogtreecommitdiffstats
path: root/nihil/guard.ccm
blob: 92305f20a68835c5400fd8d1a3e1cdf9e99750d1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
 * This source code is released into the public domain.
 */

module;

#include <concepts>
#include <functional>
#include <optional>
#include <utility>

export module nihil:guard;

namespace nihil {

/*
 * guard: invoke a callable when this object is destroyed; this is similar to
 * scope_exit from the library fundamentals TS, which LLVM doesn't implement.
 */
export template<std::invocable F>
struct guard final {
	// Initialise the guard with a callable we will invoke later.
	guard(F func) : _func(std::move(func)) {}

	/*
	 * We are being destroyed, so call the callable.
	 * If the callable throws, std::terminate() will be called.
	 */
	~guard() {
		if (_func)
			std::invoke(*_func);
	}

	// Release the guard.  This turns the destructor into a no-op.
	void release() noexcept {
		_func.reset();
	}

	// Not default-constructible or copyable.
	guard() = delete;
	guard(guard const &) = delete;
	guard(guard &&) noexcept = delete;
	guard &operator=(guard const &) = delete;
	guard &operator=(guard &&) noexcept = delete;

private:
	// The callable to be invoked when we are destroyed.
	std::optional<F> _func;
};

} // namespace nihil