boost/json/null_resource.hpp

0001 //
0002 // Copyright (c) 2020 Vinnie Falco (vinnie.falco@gmail.com)
0003 //
0004 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0005 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0006 //
0007 // Official repository: https://github.com/boostorg/json
0008 //
0009
0010 #ifndef BOOST_JSON_NULL_RESOURCE_HPP
0011 #define BOOST_JSON_NULL_RESOURCE_HPP
0012
0013 #include <boost/container/pmr/memory_resource.hpp>
0014 #include <boost/json/detail/config.hpp>
0015 #include <boost/json/memory_resource.hpp>
0016
0017 namespace boost {
0018 namespace json {
0019
0020 /** Return a pointer to the null resource.
0021
0022     This memory resource always throws the exception
0023     `std::bad_alloc` in calls to `allocate`.
0024
0025     @par Complexity
0026     Constant.
0027
0028     @par Exception Safety
0029     No-throw guarantee.
0030 */
0031 BOOST_JSON_DECL
0032 boost::container::pmr::memory_resource*
0033 get_null_resource() noexcept;
0034
0035 } // namespace json
0036 } // namespace boost
0037
0038 #endif