2. EL 8
  3. libstdc++-docs
  4. std::unique_ptr(3)

Scroll to navigation

std::unique_ptr< _Tp, _Dp >(3) Library Functions Manual std::unique_ptr< _Tp, _Dp >(3)

NAME

std::unique_ptr< _Tp, _Dp > - 20.7.1.2 unique_ptr for single objects.

SYNOPSIS

Public Types


template<typename _Up , typename _Ep > using __safe_conversion_up = __and_< is_convertible< typename unique_ptr< _Up, _Ep >::pointer, pointer >, __not_< is_array< _Up > > >
using deleter_type = _Dp
using element_type = _Tp
using pointer = typename __uniq_ptr_impl< _Tp, _Dp >::pointer

Public Member Functions


template<typename _Up = _Dp, typename = _DeleterConstraint<_Up>> constexpr unique_ptr () noexcept
Default constructor, creates a unique_ptr that owns nothing. template<typename _Up = _Dp, typename = _DeleterConstraint<_Up>> unique_ptr (pointer __p) noexcept
unique_ptr (pointer __p, typename conditional< is_reference< deleter_type >::value, deleter_type, const deleter_type &>::type __d) noexcept
unique_ptr (pointer __p, typename remove_reference< deleter_type >::type &&__d) noexcept
template<typename _Up = _Dp, typename = _DeleterConstraint<_Up>> constexpr unique_ptr (nullptr_t) noexcept
Creates a unique_ptr that owns nothing. unique_ptr (unique_ptr &&__u) noexcept
Move constructor. template<typename _Up , typename _Ep , typename = _Require< __safe_conversion_up<_Up, _Ep>, typename conditional<is_reference<_Dp>::value, is_same<_Ep, _Dp>, is_convertible<_Ep, _Dp>>::type>> unique_ptr (unique_ptr< _Up, _Ep > &&__u) noexcept
Converting constructor from another type. template<typename _Up , typename > unique_ptr (auto_ptr< _Up > &&__u) noexcept
unique_ptr (const unique_ptr &)=delete
~unique_ptr () noexcept
Destructor, invokes the deleter if the stored pointer is not null. pointer get () const noexcept
Return the stored pointer. deleter_type & get_deleter () noexcept
Return a reference to the stored deleter. const deleter_type & get_deleter () const noexcept
Return a reference to the stored deleter. operator bool () const noexcept
Return true if the stored pointer is not null. add_lvalue_reference< element_type >::type operator* () const
Dereference the stored pointer. pointer operator-> () const noexcept
Return the stored pointer. unique_ptr & operator= (unique_ptr &&__u) noexcept
Move assignment operator. template<typename _Up , typename _Ep > enable_if< __and_< __safe_conversion_up< _Up, _Ep >, is_assignable< deleter_type &, _Ep && > >::value, unique_ptr & >::type operator= (unique_ptr< _Up, _Ep > &&__u) noexcept
Assignment from another type. unique_ptr & operator= (nullptr_t) noexcept
Reset the unique_ptr to empty, invoking the deleter if necessary. unique_ptr & operator= (const unique_ptr &)=delete
pointer release () noexcept
Release ownership of any stored pointer. void reset (pointer __p=pointer()) noexcept
Replace the stored pointer. void swap (unique_ptr &__u) noexcept
Exchange the pointer and deleter with another object.

Detailed Description

template<typename _Tp, typename _Dp = default_delete<_Tp>>

class std::unique_ptr< _Tp, _Dp >" 20.7.1.2 unique_ptr for single objects.

Definition at line 168 of file unique_ptr.h.

Constructor & Destructor Documentation

template<typename _Tp, typename _Dp = default_delete<_Tp>> template<typename _Up = _Dp, typename = _DeleterConstraint<_Up>> constexpr std::unique_ptr< _Tp, _Dp >::unique_ptr () [inline], [noexcept]

Default constructor, creates a unique_ptr that owns nothing.

Definition at line 194 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> template<typename _Up = _Dp, typename = _DeleterConstraint<_Up>> std::unique_ptr< _Tp, _Dp >::unique_ptr (pointer __p) [inline], [explicit], [noexcept]

Takes ownership of a pointer.

Parameters:

__p A pointer to an object of element_type

The deleter will be value-initialized.

Definition at line 207 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> std::unique_ptr< _Tp, _Dp >::unique_ptr (pointer __p, typename conditional< is_reference< deleter_type >::value, deleter_type, const deleter_type &>::type __d) [inline], [noexcept]

Takes ownership of a pointer.

Parameters:

__p A pointer to an object of element_type
__d A reference to a deleter.

The deleter will be initialized with __d

Definition at line 218 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> std::unique_ptr< _Tp, _Dp >::unique_ptr (pointer __p, typename remove_reference< deleter_type >::type && __d) [inline], [noexcept]

Takes ownership of a pointer.

Parameters:

__p A pointer to an object of element_type
__d An rvalue reference to a deleter.

The deleter will be initialized with std::move(__d)

Definition at line 230 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> template<typename _Up = _Dp, typename = _DeleterConstraint<_Up>> constexpr std::unique_ptr< _Tp, _Dp >::unique_ptr (nullptr_t) [inline], [noexcept]

Creates a unique_ptr that owns nothing.

Definition at line 239 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> std::unique_ptr< _Tp, _Dp >::unique_ptr (unique_ptr< _Tp, _Dp > && __u) [inline], [noexcept]

Move constructor.

Definition at line 244 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> template<typename _Up , typename _Ep , typename = _Require< __safe_conversion_up<_Up, _Ep>, typename conditional<is_reference<_Dp>::value, is_same<_Ep, _Dp>, is_convertible<_Ep, _Dp>>::type>> std::unique_ptr< _Tp, _Dp >::unique_ptr (unique_ptr< _Up, _Ep > && __u) [inline], [noexcept]

Converting constructor from another type. Requires that the pointer owned by __u is convertible to the type of pointer owned by this object, __u does not own an array, and __u has a compatible deleter type.

Definition at line 258 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> std::unique_ptr< _Tp, _Dp >::~unique_ptr () [inline], [noexcept]

Destructor, invokes the deleter if the stored pointer is not null.

Definition at line 273 of file unique_ptr.h.

Member Function Documentation

template<typename _Tp, typename _Dp = default_delete<_Tp>> pointer std::unique_ptr< _Tp, _Dp >::get (void) const [inline], [noexcept]

Return the stored pointer.

Definition at line 345 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> deleter_type& std::unique_ptr< _Tp, _Dp >::get_deleter () [inline], [noexcept]

Return a reference to the stored deleter.

Definition at line 350 of file unique_ptr.h.

Referenced by std::unique_ptr< _Result< _Res > >::operator=(), std::unique_ptr< _Tp[], _Dp >::operator=(), std::unique_ptr< _Result< _Res > >::reset(), std::unique_ptr< _Tp[], _Dp >::reset(), std::unique_ptr< _Result< _Res > >::~unique_ptr(), and std::unique_ptr< _Tp[], _Dp >::~unique_ptr().

template<typename _Tp, typename _Dp = default_delete<_Tp>> const deleter_type& std::unique_ptr< _Tp, _Dp >::get_deleter () const [inline], [noexcept]

Return a reference to the stored deleter.

Definition at line 355 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> std::unique_ptr< _Tp, _Dp >::operator bool () const [inline], [explicit], [noexcept]

Return true if the stored pointer is not null.

Definition at line 359 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> add_lvalue_reference<element_type>::type std::unique_ptr< _Tp, _Dp >::operator* () const [inline]

Dereference the stored pointer.

Definition at line 329 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> pointer std::unique_ptr< _Tp, _Dp >::operator-> () const [inline], [noexcept]

Return the stored pointer.

Definition at line 337 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> unique_ptr& std::unique_ptr< _Tp, _Dp >::operator= (unique_ptr< _Tp, _Dp > && __u) [inline], [noexcept]

Move assignment operator.

Parameters:

__u The object to transfer ownership from.

Invokes the deleter first if this object owns a pointer.

Definition at line 290 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> template<typename _Up , typename _Ep > enable_if< __and_< __safe_conversion_up<_Up, _Ep>, is_assignable<deleter_type&, _Ep&&> >::value, unique_ptr&>::type std::unique_ptr< _Tp, _Dp >::operator= (unique_ptr< _Up, _Ep > && __u) [inline], [noexcept]

Assignment from another type.

Parameters:

__u The object to transfer ownership from, which owns a convertible pointer to a non-array object.

Invokes the deleter first if this object owns a pointer.

Definition at line 310 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> unique_ptr& std::unique_ptr< _Tp, _Dp >::operator= (nullptr_t) [inline], [noexcept]

Reset the unique_ptr to empty, invoking the deleter if necessary.

Definition at line 319 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> pointer std::unique_ptr< _Tp, _Dp >::release () [inline], [noexcept]

Release ownership of any stored pointer.

Definition at line 366 of file unique_ptr.h.

template<typename _Tp, typename _Dp = default_delete<_Tp>> void std::unique_ptr< _Tp, _Dp >::reset (pointer __p = pointer()) [inline], [noexcept]

Replace the stored pointer.

Parameters:

__p The new pointer to store.

The deleter will be invoked if a pointer is already owned.

Definition at line 380 of file unique_ptr.h.

Referenced by std::unique_ptr< _Result< _Res > >::operator=(), and std::unique_ptr< _Tp[], _Dp >::operator=().

template<typename _Tp, typename _Dp = default_delete<_Tp>> void std::unique_ptr< _Tp, _Dp >::swap (unique_ptr< _Tp, _Dp > & __u) [inline], [noexcept]

Exchange the pointer and deleter with another object.

Definition at line 390 of file unique_ptr.h.

Referenced by std::unique_ptr< _Result< _Res > >::reset(), and std::unique_ptr< _Tp[], _Dp >::reset().

Author

Generated automatically by Doxygen for libstdc++ from the source code.

Sat Apr 1 2023 libstdc++