vecmem::details::unique_obj_deleter< T > Struct Template Reference

A deleter class for non-trivial objects. More...

#include <vecmem/memory/details/unique_obj_deleter.hpp>

Public Types
using	pointer_t = std::conditional_t< std::is_array_v< T >, std::decay_t< T >, T * >
using	storage_t = std::remove_pointer_t< pointer_t >

Public Member Functions
	unique_obj_deleter (void)=default
	Default-construct a new unique object deleter.
	unique_obj_deleter (memory_resource &mr, std::size_t s, std::size_t a=0, std::size_t n=1)
	Construct a new unique object deleter.
	unique_obj_deleter (const unique_obj_deleter &i)=default
	Copy a unique object deleter.
	unique_obj_deleter (unique_obj_deleter &&i)=default
	Move a unique object deleter.
unique_obj_deleter &	operator= (const unique_obj_deleter &i)=default
	Copy-assign a unique object deleter.
unique_obj_deleter &	operator= (unique_obj_deleter &&i)=default
	Move-assign a unique object deleter.
void	operator() (pointer_t p) const
	Activate the deletion mechanism of the deleter.

Detailed Description

template<typename T>
struct vecmem::details::unique_obj_deleter< T >

A deleter class for non-trivial objects.

This class provides all the necessary functionality to allow unique pointers to deallocate non-trivial objects, as well as arrays of them.

Object pointers not only deallocate their memory, but they also cleanly delete the object by callings its deconstructor.

The design of this class is somewhat unconventional because it is stateful, which most deleters are not. However, this is pretty much necessary we cannot rely on the packed storage of allocation parameters that you see in standard deleters. In particular, the pointer argument is not strictly necessary, but it is included to make the class easier to debug.

Template Parameters

T	The type to deallocate.

Note

This deleter class supports non-array types and array types of unknown bound, but it does not support arrays of known bound.

Warning

This type should never be used with host-inaccessible memory! We cannot check this at compile-time or at run-time, so it is the responsibility of the user to ensure that this requirement is respected.

Constructor & Destructor Documentation

unique_obj_deleter() [1/4]

template<typename T >

vecmem::details::unique_obj_deleter< T >::unique_obj_deleter ( void  )

default

Default-construct a new unique object deleter.

Having a default constructor for this class is not ideal, as having an empty deleter here doesn't really make any sense. However, if the deleter class is not default-constructible, then neither is the std::unique_ptr class using it. For that reason, we want it here.

unique_obj_deleter() [2/4]

template<typename T >

vecmem::details::unique_obj_deleter< T >::unique_obj_deleter ( memory_resource &  mr, std::size_t  s, std::size_t  a = 0, std::size_t  n = 1  )

inline

Construct a new unique object deleter.

This is the preferred constructor for this type. It will store a memory resource, a pointer, a size, and possible an alignment and a number of elements.

Parameters

mr	The memory resource to use for deallocation.
p	The pointer which we will want to deallocate.
s	The size of the allocation.
a	The alignment of the allocation, with 0 representing no alignment.
n	The number of elements in the allocation.

unique_obj_deleter() [3/4]

template<typename T >

vecmem::details::unique_obj_deleter< T >::unique_obj_deleter ( const unique_obj_deleter< T > &  i )

default

Copy a unique object deleter.

Parameters

i	The object deleter to copy.

unique_obj_deleter() [4/4]

template<typename T >

vecmem::details::unique_obj_deleter< T >::unique_obj_deleter ( unique_obj_deleter< T > &&  i )

default

Move a unique object deleter.

Parameters

i	The object deleter to move.

Member Function Documentation

operator()()

template<typename T >

void vecmem::details::unique_obj_deleter< T >::operator() ( pointer_t  p ) const

inline

Activate the deletion mechanism of the deleter.

Parameters

p	The pointer to deallocate.

Note

The pointer argument to this function is in some ways obsolete, because we store the pointer as a member variable. However, having both makes it easier to cross-check the logic.

operator=() [1/2]

template<typename T >

unique_obj_deleter & vecmem::details::unique_obj_deleter< T >::operator= ( const unique_obj_deleter< T > &  i )

default

Copy-assign a unique object deleter.

Parameters

i	The object to copy into the current one.

Returns

A reference to this object.

operator=() [2/2]

template<typename T >

unique_obj_deleter & vecmem::details::unique_obj_deleter< T >::operator= ( unique_obj_deleter< T > &&  i )

default

Move-assign a unique object deleter.

Parameters

i	The object to move into the current one.

Returns

A reference to this object.

---

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

• core/include/vecmem/memory/details/unique_obj_deleter.hpp