cetl::pf17::pmr::deviant::memory_resource_traits< T > Struct Template Reference

#include "cetl/pf17/memory_resource.hpp"

Public Types
using	is_reallocate_defined

Public Member Functions
	memory_resource_traits (const memory_resource_traits &)=delete
memory_resource_traits &	operator= (const memory_resource_traits &)=delete

Static Public Member Functions
static constexpr std::size_t	max_size (const T &mr) noexcept
static constexpr void *	reallocate (T &mr, void *ptr, std::size_t old_size_bytes, std::size_t new_size_bytes, std::size_t alignment=alignof(std::max_align_t))

Detailed Description

template<typename T>
struct cetl::pf17::pmr::deviant::memory_resource_traits< T >

Used to access extensions to std::pmr::memory_resource that are only found in CETL.

Proper defaults are provided when using std::pmr::memory_resource.

Template Parameters

T	The type of the memory_resource to access.

Member Typedef Documentation

is_reallocate_defined

template<typename T>

using cetl::pf17::pmr::deviant::memory_resource_traits< T >::is_reallocate_defined

Initial value:

std::
    conditional_t<std::is_base_of<cetl::pf17::pmr::memory_resource, T>::value, std::true_type, std::false_type>

std::true_type if T implements reallocate otherwise std::false_type.

Member Function Documentation

max_size()

template<typename T>

static constexpr std::size_t cetl::pf17::pmr::deviant::memory_resource_traits< T >::max_size ( const T & mr )

inlinestaticconstexprnoexcept

If using a CETL memory_resource, returns the result of calling the memory_resource's max_size method otherwise returns std::numeric_limits<std::size_t>::max().

Parameters

mr	A reference to the memory_resource to query.

Returns

The maximum number of bytes that can be allocated by this memory_resource.

Referenced by cetl::pf17::pmr::deviant::basic_monotonic_buffer_resource::do_max_size(), and cetl::pf17::pmr::polymorphic_allocator< T >::max_size().

Here is the caller graph for this function:

reallocate()

template<typename T>

static constexpr void * cetl::pf17::pmr::deviant::memory_resource_traits< T >::reallocate ( T & mr, void * ptr, std::size_t old_size_bytes, std::size_t new_size_bytes, std::size_t alignment = alignof(std::max_align_t) )

inlinestaticconstexpr

If supported, this will delegate to the memory_resource's reallocate method otherwise it will return nullptr.

This follows a similar behaviour contract described by std::reallocate with the implementation defined behaviour for zero-length reallocations being to always return nullptr.

Note

The behaviour of this method when called with a different alignment then used in the original allocation is implementation defined.

Parameters

mr	The memory_resource to use for allocation.
ptr	The pointer to reallocate. If the reallocation is successful this pointer is invalid and must not be used even if it's address is the same as the returned pointer. This pointer remains valid for any failure.
old_size_bytes	The number of bytes returned by the original allocation.
new_size_bytes	The number of bytes to change ptr to hold.
alignment	The alignment of the allocated memory. CETL will treat an inability to properly align or to support re-alignment of memory as an allocation failure.

Returns

The allocated memory or std::nullptr if exceptions are disabled and an allocation failure occurs.

Exceptions

std::bad_alloc

Throws if any allocation errors occur. Implementations shall not leak memory even if the allocation fails.

---

The documentation for this struct was generated from the following file:

• /__w/CETL/CETL/include/cetl/pf17/memory_resource.hpp