logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::unique_ptr< _Tp, _Dp > - A move-only smart pointer that manages unique ownership of a resource.

Author

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

                                                    libstdc++                  std::unique_ptr<_Tp,_Dp>(3cxx)

Constructor & Destructor Documentation

template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Del=_Dp,typename=_DeleterConstraint<_Del>>constexprstd::unique_ptr<_Tp,_Dp>::unique_ptr()[inline],[constexpr],[noexcept]
       Default constructor, creates a unique_ptr that owns nothing.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Del=_Dp,typename=_DeleterConstraint<_Del>>constexprstd::unique_ptr<_Tp,_Dp>::unique_ptr(pointer__p)[inline],[explicit],[constexpr],[noexcept]
       Takes ownership of a pointer.

       Parameters__p A pointer to an object of element_type

       The deleter will be value-initialized.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Del=deleter_type,typename=_Require<is_copy_constructible<_Del>>>constexprstd::unique_ptr<_Tp,_Dp>::unique_ptr(pointer__p,constdeleter_type&__d)[inline],[constexpr],[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

   template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Del=deleter_type,typename=_Require<is_move_constructible<_Del>>>constexprstd::unique_ptr<_Tp,_Dp>::unique_ptr(pointer__p,__enable_if_t<!is_lvalue_reference<_Del>::value,_Del&&>__d)[inline],[constexpr],[noexcept]
       Takes ownership of a pointer.

       Parameters__p A pointer to an object of element_type
           __d An rvalue reference to a (non-reference) deleter.

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

   template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Del=_Dp,typename=_DeleterConstraint<_Del>>constexprstd::unique_ptr<_Tp,_Dp>::unique_ptr(nullptr_t)[inline],[constexpr],[noexcept]
       Creates a unique_ptr that owns nothing.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>std::unique_ptr<_Tp,_Dp>::unique_ptr(unique_ptr<_Tp,_Dp>&&)[default]
       Move constructor.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Up,typename_Ep,typename=_Require<__safe_conversion_up<_Up,_Ep>,__conditional_t<is_reference<_Dp>::value,is_same<_Ep,_Dp>,is_convertible<_Ep,_Dp>>>>constexprstd::unique_ptr<_Tp,_Dp>::unique_ptr(unique_ptr<_Up,_Ep>&&__u)[inline],[constexpr],[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.

   template<typename_Tp,typename_Dp>template<typename_Up,typename>std::unique_ptr<_Tp,_Dp>::unique_ptr(auto_ptr<_Up>&&__u)[inline],[noexcept]
       Converting constructor from auto_ptr.

   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.

       References std::unique_ptr<_Tp,_Dp>::get_deleter(), and std::move().

Detailed Description

template<typename_Tp,typename_Dp=default_delete<_Tp>>
       class std::unique_ptr< _Tp, _Dp >"A move-only smart pointer that manages unique ownership of a resource.

       Since
           C++11

Member Function Documentation

template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprpointerstd::unique_ptr<_Tp,_Dp>::get()const[inline],[constexpr],[noexcept]
       Return the stored pointer.

       Referenced by std::unique_ptr<_Tp,_Dp>::operatorbool(), std::unique_ptr<_Tp[],_Dp>::operatorbool(), std::unique_ptr<_Tp,_Dp>::operator*(), std::unique_ptr<_Tp,_Dp>::operator->(), and
       std::unique_ptr<_Tp[],_Dp>::operator[]().

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprconstdeleter_type&std::unique_ptr<_Tp,_Dp>::get_deleter()const[inline],[constexpr],[noexcept]
       Return a reference to the stored deleter.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprdeleter_type&std::unique_ptr<_Tp,_Dp>::get_deleter()[inline],[constexpr],[noexcept]
       Return a reference to the stored deleter.

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

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprstd::unique_ptr<_Tp,_Dp>::operatorbool()const[inline],[explicit],[constexpr],[noexcept]
       Return true if the stored pointer is not null.

       References std::unique_ptr<_Tp,_Dp>::get().

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexpradd_lvalue_reference<element_type>::typestd::unique_ptr<_Tp,_Dp>::operator*()const[inline],[constexpr],[noexcept]
       Dereference the stored pointer.

       References std::unique_ptr<_Tp,_Dp>::get().

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprpointerstd::unique_ptr<_Tp,_Dp>::operator->()const[inline],[constexpr],[noexcept]
       Return the stored pointer.

       References std::unique_ptr<_Tp,_Dp>::get().

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprunique_ptr&std::unique_ptr<_Tp,_Dp>::operator=(nullptr_t)[inline],[constexpr],[noexcept]
       Reset the unique_ptr to empty, invoking the deleter if necessary.

       References std::unique_ptr<_Tp,_Dp>::reset().

   template<typename_Tp,typename_Dp=default_delete<_Tp>>unique_ptr&std::unique_ptr<_Tp,_Dp>::operator=(unique_ptr<_Tp,_Dp>&&)[default]
       Move assignment operator. Invokes the deleter if this object owns a pointer.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>template<typename_Up,typename_Ep>constexprenable_if<__and_<__safe_conversion_up<_Up,_Ep>,is_assignable<deleter_type&,_Ep&&>>::value,unique_ptr&>::typestd::unique_ptr<_Tp,_Dp>::operator=(unique_ptr<_Up,_Ep>&&__u)[inline],[constexpr],[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 if this object owns a pointer.

       References std::unique_ptr<_Tp,_Dp>::get_deleter(), and std::unique_ptr<_Tp,_Dp>::reset().

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprpointerstd::unique_ptr<_Tp,_Dp>::release()[inline],[constexpr],[noexcept]
       Release ownership of any stored pointer.

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprvoidstd::unique_ptr<_Tp,_Dp>::reset(pointer__p=pointer())[inline],[constexpr],[noexcept]
       Replace the stored pointer.

       Parameters__p The new pointer to store.

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

       References std::move().

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

   template<typename_Tp,typename_Dp=default_delete<_Tp>>constexprvoidstd::unique_ptr<_Tp,_Dp>::swap(unique_ptr<_Tp,_Dp>&__u)[inline],[constexpr],[noexcept]
       Exchange the pointer and deleter with another object.

Name

       std::unique_ptr< _Tp, _Dp > - A move-only smart pointer that manages unique ownership of a resource.

Synopsis

       #include <memory>

   PublicTypesusingdeleter_type = _Dpusingelement_type = _Tp
       usingpointer = typename__uniq_ptr_impl< _Tp, _Dp >::pointer

   PublicMemberFunctions
       template<typename_Del  = _Dp, typename  = _DeleterConstraint<_Del>> constexpr unique_ptr () noexcept
           Default constructor, creates a unique_ptr that owns nothing.
       template<typename _Up , typename  = _Require<            is_convertible<_Up*, _Tp*>, is_same<_Dp,
           default_delete<_Tp>>>> unique_ptr (auto_ptr< _Up > &&__u) noexcept
           Converting constructor from auto_ptr.
       unique_ptr (const unique_ptr &)=delete
       template<typename_Del  = _Dp, typename  = _DeleterConstraint<_Del>> constexpr unique_ptr (nullptr_t)
           noexcept
           Creates a unique_ptr that owns nothing.
       template<typename_Del  = _Dp, typename  = _DeleterConstraint<_Del>> constexpr unique_ptr (pointer __p)
           noexcept
       template<typename_Del  = deleter_type, typename  = _Require<is_move_constructible<_Del>>> constexpr
           unique_ptr (pointer __p, __enable_if_t<!is_lvalue_reference< _Del >::value, _Del && > __d) noexcept
       template<typename_Del  = deleter_type, typename  = _Require<is_copy_constructible<_Del>>> constexpr
           unique_ptr (pointer __p, const deleter_type &__d) noexcept
       template<typename_Del  = deleter_type, typename_DelUnref  = typename remove_reference<_Del>::type>
           constexpr unique_ptr (pointer, __enable_if_t< is_lvalue_reference< _Del >::value, _DelUnref &&
           >)=deleteunique_ptr (unique_ptr &&)=default
           Move constructor.
       template<typename _Up , typename_Ep , typename  = _Require<               __safe_conversion_up<_Up,
           _Ep>,           __conditional_t<is_reference<_Dp>::value,                    is_same<_Ep,
           _Dp>,                      is_convertible<_Ep, _Dp>>>> constexpr unique_ptr (unique_ptr< _Up, _Ep >
           &&__u) noexcept
           Converting constructor from another type.
       ~unique_ptr () noexcept
           Destructor, invokes the deleter if the stored pointer is not null.
       constexpr pointer get () const noexcept
           Return the stored pointer.
       constexpr const deleter_type & get_deleter () const noexcept
           Return a reference to the stored deleter.
       constexpr deleter_type & get_deleter () noexcept
           Return a reference to the stored deleter.
       constexpr operatorbool () const noexcept
           Return true if the stored pointer is not null.
       constexpr add_lvalue_reference< element_type >::type operator* () const noexcept(noexcept(*std::declval<
           pointer >()))
           Dereference the stored pointer.
       constexpr pointer operator-> () const noexcept
           Return the stored pointer.
       unique_ptr & operator= (const unique_ptr &)=delete
       constexpr unique_ptr & operator= (nullptr_t) noexcept
           Reset the unique_ptr to empty, invoking the deleter if necessary.
       unique_ptr & operator= (unique_ptr &&)=default
           Move assignment operator.
       template<typename _Up , typename_Ep > constexpr 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.
       constexpr pointer release () noexcept
           Release ownership of any stored pointer.
       constexpr voidreset (pointer __p=pointer()) noexcept
           Replace the stored pointer.
       constexpr voidswap (unique_ptr &__u) noexcept
           Exchange the pointer and deleter with another object.

   RelatedSymbols
       (Note that these are not member symbols.)
       template<typename _Tp , typename... _Args> constexpr __detail::__unique_ptr_t< _Tp > make_unique (_Args
           &&... __args)
       template<typename _Tp , typename... _Args> __detail::__invalid_make_unique_t< _Tp > make_unique (_Args
           &&...)=delete
       template<typename _Tp > constexpr __detail::__unique_ptr_array_t< _Tp > make_unique (size_t __num)
       template<typename _Tp > constexpr __detail::__unique_ptr_t< _Tp > make_unique_for_overwrite ()
       template<typename _Tp , typename... _Args> __detail::__invalid_make_unique_t< _Tp >
           make_unique_for_overwrite (_Args &&...)=delete
       template<typename _Tp > constexpr __detail::__unique_ptr_array_t< _Tp > make_unique_for_overwrite (size_t
           __num)
       template<typename _CharT , typename _Traits , typename _Tp , typename_Dp > basic_ostream< _CharT,
           _Traits > & operator<< (basic_ostream< _CharT, _Traits > &__os, const unique_ptr< _Tp, _Dp > &__p)
           Stream output operator for unique_ptr.
       template<typename _Tp , typename_Dp > constexpr enable_if< __is_swappable< _Dp >::value >::type swap
           (unique_ptr< _Tp, _Dp > &__x, unique_ptr< _Tp, _Dp > &__y) noexcept

See Also