memory::allocated_ptr< Alloc > Struct Template Reference

Non-standard RAII type for managing pointers obtained from allocators. More...

#include <allocator_ptr.h>

Collaboration diagram for memory::allocated_ptr< Alloc >:

Public Types
using	pointer = typename ::std::allocator_traits< Alloc >::pointer
using	value_type = typename ::std::allocator_traits< Alloc >::value_type

Public Member Functions
	allocated_ptr (Alloc &a, pointer p) noexcept
	Take ownership of p.
template<class Ptr , class = nostd::enable_if_t<::std::is_same<Ptr, value_type*>::value>>
	allocated_ptr (Alloc &a, Ptr p)
	Convert __ptr to allocator's pointer type and take ownership of it.
	allocated_ptr (allocated_ptr &&gd) noexcept
	Transfer ownership of the owned pointer.
	~allocated_ptr ()
	Deallocate the owned pointer.
allocated_ptr &	operator= (std::nullptr_t) noexcept
	Release ownership of the owned pointer.
value_type *	get () noexcept
	Get the address that the owned pointer refers to.

Private Attributes
Alloc *	alloc_
pointer	ptr_

Detailed Description

template<class Alloc>
struct memory::allocated_ptr< Alloc >

Non-standard RAII type for managing pointers obtained from allocators.

Definition at line 17 of file allocator_ptr.h.

Member Typedef Documentation

pointer

template<class Alloc >

using memory::allocated_ptr< Alloc >::pointer = typename ::std::allocator_traits<Alloc>::pointer

Definition at line 18 of file allocator_ptr.h.

value_type

template<class Alloc >

using memory::allocated_ptr< Alloc >::value_type = typename ::std::allocator_traits<Alloc>::value_type

Definition at line 19 of file allocator_ptr.h.

Constructor & Destructor Documentation

allocated_ptr() [1/3]

template<class Alloc >

memory::allocated_ptr< Alloc >::allocated_ptr ( Alloc &  a, pointer  p  )

inlinenoexcept

Take ownership of p.

Definition at line 22 of file allocator_ptr.h.

allocated_ptr() [2/3]

template<class Alloc >

template<class Ptr , class = nostd::enable_if_t<::std::is_same<Ptr, value_type*>::value>>

memory::allocated_ptr< Alloc >::allocated_ptr ( Alloc &  a, Ptr  p  )

inline

Convert __ptr to allocator's pointer type and take ownership of it.

Definition at line 26 of file allocator_ptr.h.

allocated_ptr() [3/3]

template<class Alloc >

memory::allocated_ptr< Alloc >::allocated_ptr ( allocated_ptr< Alloc > &&  gd )

inlinenoexcept

Transfer ownership of the owned pointer.

Definition at line 29 of file allocator_ptr.h.

~allocated_ptr()

template<class Alloc >

memory::allocated_ptr< Alloc >::~allocated_ptr ( )

inline

Deallocate the owned pointer.

Definition at line 32 of file allocator_ptr.h.

Member Function Documentation

get()

template<class Alloc >

value_type * memory::allocated_ptr< Alloc >::get ( )

inlinenoexcept

Get the address that the owned pointer refers to.

Definition at line 45 of file allocator_ptr.h.

operator=()

template<class Alloc >

allocated_ptr & memory::allocated_ptr< Alloc >::operator= ( std::nullptr_t  )

inlinenoexcept

Release ownership of the owned pointer.

Definition at line 39 of file allocator_ptr.h.

Field Documentation

alloc_

template<class Alloc >

Alloc* memory::allocated_ptr< Alloc >::alloc_

private

Definition at line 48 of file allocator_ptr.h.

ptr_

template<class Alloc >

pointer memory::allocated_ptr< Alloc >::ptr_

private

Definition at line 49 of file allocator_ptr.h.

---

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

• /home/runner/work/libcopp/libcopp/include/libcopp/utils/memory/allocator_ptr.h