std::experi...ue_resource(3)

💅 NAME

std::experimental::unique_resource — bestie, it's literally the universal RAII wrapper ✨ (std::experimental::unique_resource, in the C++ Standard Library manual, no cap)

---

✨ SYNOPSIS

Declared right here, in header <experimental/scope>:

Defined in header <experimental/scope>
template< class R, class D >            (library fundamentals TS v3)
class unique_resource;

Okay so unique_resource is a universal RAII wrapper for resource handles 🫶 — it owns and manages a resource through a handle, and it disposes of that resource when the unique_resource gets destroyed. Main character energy: it holds the thing, then it lets the thing go. Periodt.

The resource gets disposed of using the deleter of type D whenever either of these happens:

• the managing unique_resource object is destroyed 💀
• the managing unique_resource object is assigned from another resource via operator= or reset() 🔁

Now, let type RS be R if R is an object type, or std::reference_wrapper<std::remove_reference_t<R>> otherwise:

• unique_resource effectively holds a subobject of type RS which is or wraps the resource handle, a deleter of type D, and a bool flag indicating whether the wrapper is owning the resource 🎀
• For explanatory purposes only, that subobject of type RS is called the stored resource handle, and the stored (if R is an object type) or wrapped (if R is a reference type) R is called the underlying resource handle. These two terms are not used by the LFTS 👀 (yes, really — they're just so we can all talk about it without vibing into confusion).

---

🎀 TEMPLATE PARAMETERS

• R — resource handle type 🌸
• D — deleter type 🦋

---

💖 TYPE REQUIREMENTS

• R shall be an object type or an lvalue reference to an object type. Let UnrefR be std::remove_reference_t<R>; UnrefR shall be MoveConstructible, and if UnrefR is not CopyConstructible, std::is_nothrow_move_constructible_v<UnrefR> shall be true. ⚠️ Not a suggestion, bestie — this is a shall.
• D shall be a Destructible and MoveConstructible FunctionObject type, and if D is not CopyConstructible, std::is_nothrow_move_constructible_v<D> shall be true. Given an lvalue d of type D and an lvalue r of type UnrefR, the expression d(r) shall be well-formed. 🔥

---

👑 MEMBER FUNCTIONS

• constructor — constructs a new unique_resource (public member function) ✨
• destructor — disposes the managed resource if such is present (public member function) 💀
• operator= — assigns a unique_resource (public member function) 🔁

🌸 MODIFIERS

• release — releases the ownership (public member function) 🕊️
• reset — disposes or replaces the managed resource (public member function) 🧹

⭐ OBSERVERS

• get — accesses the underlying resource handle (public member function) 👀
• get_deleter — accesses the deleter used for disposing of the managed resource (public member function) 🔍
• operator*, operator-> — accesses the pointee if the resource handle is a pointer (public member function) 🎯

🌈 NON-MEMBER FUNCTIONS

• make_unique_resource_checked — creates a unique_resource, checking invalid value (function template) ✅

💜 Deduction guides

(yep, they exist — that's the whole entry, bestie 🎀)

---

🔥 NOTES

Resource handle types satisfying NullablePointer can also be managed by std::unique_ptr. But — and this is the slay part — unlike unique_ptr, unique_resource does not require NullablePointer. 💅 It's giving flexible.

---

🍓 EXAMPLE

This section is incomplete. Reason: no example 😭

---

💜 SEE ALSO

• unique_ptr — smart pointer with unique object ownership semantics (C++11) (class template) 👑

---

Category: Todo no example 🫠

---

and that's the whole page, bestie 💖 straight from cppreference.com, dated 2024.06.10 — go forth and manage your resources responsibly 🧚✨