std::pmr::null_memory_resource

From cppreference.com
< cpp‎ | memory
 
 
Utilities library
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)
 
Dynamic memory management
Smart pointers
(C++11)
(C++11)
(C++11)
(until C++17)
(C++11)
(C++23)
Allocators
Memory resources
pmr::null_memory_resource
(C++17)
Uninitialized storage
Uninitialized memory algorithms
Constrained uninitialized memory algorithms
Garbage collection support
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
Miscellaneous
(C++20)
(C++11)
(C++11)
 
Defined in header <memory_resource>
std::pmr::memory_resource* null_memory_resource() noexcept;
(since C++17)

Returns a pointer to a memory_resource that doesn't perform any allocation.

Return value

Returns a pointer p to a static storage duration object of a type derived from std::pmr::memory_resource, with the following properties:

  • its allocate() function always throws std::bad_alloc;
  • its deallocate() function has no effect;
  • for any memory_resource r, p->is_equal(r) returns &r == p.

The same value is returned every time this function is called.

Example

The program demos the main usage of null_memory_resouce: ensure that a memory pool which requires memory allocated on the stack will NOT allocate memory on the heap if it needs more memory.

#include <array>
#include <cstddef>
#include <iostream>
#include <memory_resource>
#include <string>
#include <unordered_map>
 
int main()
{
    // allocate memory on the stack
    std::array<std::byte, 20000> buf;
 
    // without fallback memory allocation on heap
    std::pmr::monotonic_buffer_resource pool{ buf.data(), buf.size(),
                                              std::pmr::null_memory_resource() };
 
    // allocate too much memory
    std::pmr::unordered_map<long, std::pmr::string> coll{ &pool };
    try
    {
        for (std::size_t i = 0; i < buf.size(); ++i)
        {
            coll.emplace(i, "just a string with number " + std::to_string(i));
 
            if (i && i % 50 == 0)
                std::clog << "size: " << i << "...\n";
        }
    }
    catch(const std::bad_alloc& e)
    {
        std::cerr << e.what() << '\n';
    }
 
    std::cout << "size: " << coll.size() << '\n';
}

Possible output:

size: 50...
size: 100...
size: 150...
std::bad_alloc
size: 183