cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator > Class Template Reference

#include "cetl/pmr/memory.hpp"

Public Types
using	allocator = PolymorphicDeallocator
using	value_type = typename PolymorphicDeallocator::value_type
using	unique_ptr = std::unique_ptr<value_type, cetl::pmr::PolymorphicDeleter<PolymorphicDeallocator>>

Public Member Functions
	PolymorphicDeleter (const PolymorphicDeallocator &alloc, std::size_t object_count) noexcept(std::is_nothrow_copy_constructible< PolymorphicDeallocator >::value)
	PolymorphicDeleter (PolymorphicDeleter &&rhs) noexcept(std::is_nothrow_move_constructible< PolymorphicDeallocator >::value)
PolymorphicDeleter &	operator= (PolymorphicDeleter &&rhs) noexcept(std::is_nothrow_move_assignable< PolymorphicDeallocator >::value)
	PolymorphicDeleter (const PolymorphicDeleter &rhs) noexcept(std::is_nothrow_copy_constructible< PolymorphicDeallocator >::value)
PolymorphicDeleter &	operator= (const PolymorphicDeleter &rhs) noexcept(std::is_nothrow_copy_assignable< PolymorphicDeallocator >::value)
void	operator() (value_type *p) noexcept

Detailed Description

template<typename PolymorphicDeallocator>
class cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator >

RAII helper for cetl::pf17::pmr::polymorphic_allocator and std::pmr::polymorphic_allocator.

This type is designed to work with std::unique_ptr but is still cumbersome to use. Use with cetl::pmr::Factory for the best and safest experience. Remember, be safe, use the cetl::pmr::Factory.

Note

See cetl::pmr::Factory for an example of how to use this type.

Template Parameters

PolymorphicDeallocator

The type of the polymorphic allocator to use for deallocation.

Member Typedef Documentation

allocator

template<typename PolymorphicDeallocator>

using cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator >::allocator = PolymorphicDeallocator

The allocator type this deleter uses to, uh... delete memory?

unique_ptr

template<typename PolymorphicDeallocator>

using cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator >::unique_ptr = std::unique_ptr<value_type, cetl::pmr::PolymorphicDeleter<PolymorphicDeallocator>>

While this object is simply a functor and could be used with other smart pointers the design is optimized for and tested with this std::unique_ptr type.

value_type

template<typename PolymorphicDeallocator>

using cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator >::value_type = typename PolymorphicDeallocator::value_type

The type this deleter, you know...deletes? (It is in the name of the class and all)

Constructor & Destructor Documentation

PolymorphicDeleter()

template<typename PolymorphicDeallocator>

cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator >::PolymorphicDeleter ( const PolymorphicDeallocator & alloc, std::size_t object_count )

inlinenoexcept

Designated constructor that copies a given allocator and records the object count to use when deleting the smart pointer resources.

Parameters

alloc	The allocator to use when deleting the objects in the smart pointer.
object_count	The number of objects in the smart pointer that will be deleted.

Member Function Documentation

operator()()

template<typename PolymorphicDeallocator>

void cetl::pmr::PolymorphicDeleter< PolymorphicDeallocator >::operator() ( value_type * p )

inlinenoexcept

Functor called by smart-pointer to deallocate and deconstruct objects.

Parameters

p	The object to deconstruct and deallocate.

---

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

• /__w/CETL/CETL/include/cetl/pmr/memory.hpp