STD::PMR_MONOTONIC_BUFFER_RESOURCE(3)

💖 std::pmr::monotonic_buffer_resource 💖

okay bestie, sit DOWN, because we're about to talk about the manual page for std::pmr::monotonic_buffer_resource from the Library Functions Manual, and honestly? she's iconic. ✨

---

🌸 NAME 🌸

std::pmr::monotonic_buffer_resource — a memory resource that allocates from a fixed-size buffer. that's it, that's the girl. no cap. 🫶

---

✨ SYNOPSIS ✨

#include <memory_resource>

she inherits std::pmr::memory_resource, like the main character energy she is. 👑

🎀 Public Member Functions 🎀

• monotonic_buffer_resource(const monotonic_buffer_resource &)=delete — copy constructor? deleted. we do NOT do copies here. 🙈
• monotonic_buffer_resource(memory_resource *__upstream) noexcept — builds one with just an upstream resource. that's it.
• monotonic_buffer_resource(size_t __initial_size) noexcept — builds one with just an initial size.
• monotonic_buffer_resource(size_t __initial_size, memory_resource *__upstream) noexcept — size AND upstream, the deluxe combo. 💅
• monotonic_buffer_resource(void *__buffer, size_t __buffer_size) noexcept — hands her a buffer to start with. cute.
• monotonic_buffer_resource(void *__buffer, size_t __buffer_size, memory_resource *__upstream) noexcept — buffer, buffer size, and upstream. the full set, periodt.
• void * allocate(size_t __bytes, size_t __alignment=_S_max_align) — gimme memory bestie 💖
• void deallocate(void *__p, size_t __bytes, size_t __alignment=_S_max_align) — (spoiler: this one is lowkey a no-op, more on that below 😭)
• bool is_equal(const memory_resource &__other) const noexcept — are we the same? vibe check. 🌈
• monotonic_buffer_resource & operator=(const monotonic_buffer_resource &)=delete — assignment? also deleted. no take-backs, no swaps. 💀
• void release() noexcept — the big reset. returns all the memory back upstream. 🦋
• memory_resource * upstream_resource() const noexcept — who's your upstream? spill. 🍓

🧚 Protected Member Functions 🧚

• void * do_allocate(size_t __bytes, size_t __alignment) override — the real one doing the allocating.
• void do_deallocate(void *, size_t, size_t) override — the real one doing the (non-)deallocating.
• bool do_is_equal(const memory_resource &__other) const noexcept override — the real one doing the comparing.

---

💜 Detailed Description 💜

A memory resource that allocates from a fixed-size buffer. (yes, saying it again, it's the whole point bestie 💅)

The main feature of a pmr::monotonic_buffer_resource is that its do_deallocate does nothing. and that's not a bug, that's the flex. it makes it very fast because there is no need to manage a free list, and every allocation simply returns a new block of memory, rather than searching for a suitably-sized free block. no searching. no scrolling. just vibes. ✨

Because deallocating is a no-op, the amount of memory used by the resource only grows until release() (or the destructor) is called to return all memory to upstream. so yeah, she's a hoarder, but like, in a purposeful way. 🎀

A monotonic_buffer_resource can be initialized with a buffer that will be used to satisfy all allocation requests, until the buffer is full. After that a new buffer will be allocated from the upstream resource. and here's the galaxy-brain move: by using a stack buffer and pmr::null_memory_resource() as the upstream you can get a memory resource that only uses the stack and never dynamically allocates. hello?? that's so clean. 😭✨

Since: C++17 — she's been serving since C++17 and she has not slowed down once. periodt. 👑

---

🦋 Member Function Documentation 🦋

void * std::pmr::monotonic_buffer_resource::do_allocate(size_t __bytes, size_t __alignment) [inline], [override], [protected], [virtual]

Implements std::pmr::memory_resource.

void std::pmr::monotonic_buffer_resource::do_deallocate(void * , size_t , size_t ) [inline], [override], [protected], [virtual]

Implements std::pmr::memory_resource. (remember: she does nothing and we love her for it 💀💖)

bool std::pmr::monotonic_buffer_resource::do_is_equal(const memory_resource & __other) const [inline], [override], [protected], [virtual], [noexcept]

Implements std::pmr::memory_resource.

---

🌟 Author 🌟

Generated automatically by Doxygen for libstdc++ from the source code. (yes she was built by a robot and yes she still ate 💅)

---

and that's the whole page bestie!! thanks for reading, mwah 🫶💖 this was std::pmr::...er_resource(3) from the libstdc++ fam — go forth and allocate monotonically, you gorgeous thing. ✨🌸🎀