unique_ptr 类

存储指向拥有的对象或数组的指针。 此对象/数组仅由 unique_ptr 拥有。 unique_ptr 被销毁后，此对象/数组也将被销毁。

语法

class unique_ptr {
public:
    unique_ptr();
    unique_ptr(nullptr_t Nptr);
    explicit unique_ptr(pointer Ptr);
    unique_ptr(pointer Ptr,
        typename conditional<is_reference<Del>::value, Del,
        typename add_reference<const Del>::type>::type Deleter);
    unique_ptr(pointer Ptr,
        typename remove_reference<Del>::type&& Deleter);
    unique_ptr(unique_ptr&& Right);
    template <class T2, Class Del2>
    unique_ptr(unique_ptr<T2, Del2>&& Right);
    unique_ptr(const unique_ptr& Right) = delete;
    unique_ptr& operator=(const unique_ptr& Right) = delete;
};

//Specialization for arrays:
template <class T, class D>
class unique_ptr<T[], D> {
public:
    typedef pointer;
    typedef T element_type;
    typedef D deleter_type;
    constexpr unique_ptr() noexcept;
    template <class U>
    explicit unique_ptr(U p) noexcept;
    template <class U>
    unique_ptr(U p, see below d) noexcept;
    template <class U>
    unique_ptr(U p, see below d) noexcept;
    unique_ptr(unique_ptr&& u) noexcept;
    constexpr unique_ptr(nullptr_t) noexcept : unique_ptr() { }     template <class U, class E>
        unique_ptr(unique_ptr<U, E>&& u) noexcept;
    ~unique_ptr();
    unique_ptr& operator=(unique_ptr&& u) noexcept;
    template <class U, class E>
    unique_ptr& operator=(unique_ptr<U, E>&& u) noexcept;
    unique_ptr& operator=(nullptr_t) noexcept;
    T& operator[](size_t i) const;

    pointer get() const noexcept;
    deleter_type& get_deleter() noexcept;
    const deleter_type& get_deleter() const noexcept;
    explicit operator bool() const noexcept;
    pointer release() noexcept;
    void reset(pointer p = pointer()) noexcept;
    void reset(nullptr_t = nullptr) noexcept;
    template <class U>
    void reset(U p) noexcept = delete;
    void swap(unique_ptr& u) noexcept;  // disable copy from lvalue unique_ptr(const unique_ptr&) = delete;
    unique_ptr& operator=(const unique_ptr&) = delete;
};

参数

Right
一个 unique_ptr。

Nptr
类型为 rvalue 的 std::nullptr_t。

Ptr
一个 pointer。

Deleter
绑定到 deleter 的 unique_ptr 函数。

异常

unique_ptr 不生成异常。

注解

unique_ptr 类取代 auto_ptr，并可用作 C++ 标准库容器的元素。

使用 make_unique helper 函数可高效创建 unique_ptr 的新实例。

unique_ptr 唯一管理资源。 每个 unique_ptr 对象均存储一个指向其拥有的对象的指针，或存储一个 null 指针。 资源只能由一个 unique_ptr 对象拥有；当拥有特定资源的 unique_ptr 对象被销毁后，该资源将被释放。 unique_ptr 对象可以移动，但不能复制；有关详细信息，请参阅 rvalue 引用声明符：&&。

资源通过调用 deleter 类型的已存储 Del 对象来释放，此对象知道如何为特定 unique_ptr 分配资源。 默认 deleterdefault_delete<T> 假定 ptr 指向的资源通过 new 分配，并且此资源可通过调用 delete _Ptr 释放。 （部分专用化 unique_ptr<T[]> 管理通过 new[] 分配的数组对象，并具有经过专用化以调用 delete[] ptr 的默认 deleterdefault_delete<T[]>。）

指向拥有的资源的存储指针 stored_ptr 具有类型 pointer。 如果已定义，此为 Del::pointer，如果未定义，则为 T *。 如果 deleter 无状态，则存储的 stored_deleter 对象 deleter 不占用任何空间。 请注意，Del 可以为引用类型。

成员

构造函数

名称	描述
unique_ptr	unique_ptr 有七个构造函数。

Typedef

名称	描述
deleter_type	模板参数 Del 的同义词。
element_type	模板参数 T 的同义词。
pointer	如果已定义，为 Del::pointer 的同义词，否则为 T * 的同义词。

函数

名称	描述
get	返回 stored_ptr。
get_deleter	返回 stored_deleter的引用。
release	将 pointer() 存储在 stored_ptr 中并返回其先前内容。
reset	释放当前拥有的资源并接受新资源。
swap	使用提供的 deleter 交换资源和 unique_ptr。

运算符

名称	描述
operator bool	此运算符返回可转换为 bool 的类型的值。 当 bool 时，转换为 true 的结果为 get() != pointer()，否则为 false。
operator->	成员函数返回 stored_ptr。
operator*	成员函数返回 *stored_ptr。
operator=	将 unique_ptr（或 pointer-type）的值分配给当前 unique_ptr。

deleter_type

该类型是模板参数 Del 的同义词。

typedef Del deleter_type;

备注

该类型是模板参数 Del 的同义词。

element_type

该类型是模板参数 Type 的同义词。

typedef Type element_type;

注解

该类型是模板参数 Ty 的同义词。

get

返回 stored_ptr。

pointer get() const;

备注

成员函数返回 stored_ptr。

get_deleter

返回 stored_deleter的引用。

Del& get_deleter();

const Del& get_deleter() const;

备注

成员函数返回对 stored_deleter 的引用。

operator=

将提供的 unique_ptr 的地址分配给当前地址。

unique_ptr& operator=(unique_ptr&& right);
template <class U, Class Del2>
unique_ptr& operator=(unique_ptr<Type, Del>&& right);
unique_ptr& operator=(pointer-type);

参数

一个 unique_ptr 引用，用于将值 of 分配给当前 unique_ptr。

注解

成员函数会调用 reset(right.release()) 并将 right.stored_deleter 移动到 stored_deleter，然后返回 *this。

pointer

如果已定义，为 Del::pointer 的同义词，否则为 Type * 的同义词。

typedef T1 pointer;

备注

如果已定义，则此类型为 Del::pointer 的同义词，否则为 Type * 的同义词。

release

释放给调用方返回的存储指针的所有权，并将存储的指针值设置为nullptr。

pointer release();

注解

使用 release接管unique_ptr存储的原始指针的所有权。 调用方负责返回的指针的删除。 unique-ptr设置为空的默认构造状态。 在调用到unique_ptr后，您可以将兼容类型的另一个指针分配到release。

示例

此示例显示发布的调用方如何负责返回的对象：

// stl_release_unique.cpp
// Compile by using: cl /W4 /EHsc stl_release_unique.cpp
#include <iostream>
#include <memory>

struct Sample {
   int content_;
   Sample(int content) : content_(content) {
      std::cout << "Constructing Sample(" << content_ << ")" << std::endl;
   }
   ~Sample() {
      std::cout << "Deleting Sample(" << content_ << ")" << std::endl;
   }
};

void ReleaseUniquePointer() {
   // Use make_unique function when possible.
   auto up1 = std::make_unique<Sample>(3);
   auto up2 = std::make_unique<Sample>(42);

   // Take over ownership from the unique_ptr up2 by using release
   auto ptr = up2.release();
   if (up2) {
      // This statement does not execute, because up2 is empty.
      std::cout << "up2 is not empty." << std::endl;
   }
   // We are now responsible for deletion of ptr.
   delete ptr;
   // up1 deletes its stored pointer when it goes out of scope.
}

int main() {
   ReleaseUniquePointer();
}

Constructing Sample(3)
Constructing Sample(42)
Deleting Sample(42)
Deleting Sample(3)

reset

取得指针参数的所有权，然后删除原始存储的指针。 如果新指针与原始存储指针相同，reset将删除指针并将存储的指针设置为nullptr。

void reset(pointer ptr = pointer());
void reset(nullptr_t ptr);

参数

ptr
指向要取得所有权的资源的指针。

备注

使用 reset 将 unique_ptr 拥有的存储 pointer 更改为 ptr，然后删除原始存储的指针。 如果 unique_ptr 不为空，reset 将调用原始存储指针上的 get_deleter 返回的 deleter 函数。

因为 reset 首先将存储新指针 ptr，然后删除原始存储的指针，如果与原始存储的指针相同，则 reset 可以立即删除 ptr。

swap

交换两个 unique_ptr 对象之间的指针。

void swap(unique_ptr& right);

参数

right
用于交换指针的 unique_ptr。

备注

成员函数将 stored_ptr 与 right.stored_ptr、stored_deleter 与 right.stored_deleter 进行交换。

unique_ptr

unique_ptr 有七个构造函数。

unique_ptr();

unique_ptr(nullptr_t);
explicit unique_ptr(pointer ptr);

unique_ptr(
    Type* ptr,
    typename conditional<
    is_reference<Del>::value,
    Del,
    typename add_reference<const Del>::type>::type _Deleter);

unique_ptr(pointer ptr, typename remove_reference<Del>::type&& _Deleter);
unique_ptr(unique_ptr&& right);
template <class Ty2, Class Del2>
    unique_ptr(unique_ptr<Ty2, Del2>&& right);

参数

ptr
指向要分配给 unique_ptr 的资源的指针。

_Deleter
要分配给 unique_ptr 的 deleter。

right
unique_ptr 的 rvalue reference，其中 unique_ptr 字段为分配给最近构造的 unique_ptr 的移动。

备注

前两个构造函数用于构造不管理任何资源的对象。 第三个构造函数用于将 ptr 存储到 stored_ptr 中。 第四个构造函数用于将 ptr 存储到 stored_ptr 中和将 deleter 存储到 stored_deleter 中。

第五个构造函数用于将 ptr 存储到 stored_ptr 中和将 deleter 移动到 stored_deleter 中。 第六和第七个构造函数用于将 right.release() 存储到 stored_ptr 中和将 right.get_deleter() 移动到 stored_deleter 中。

~unique_ptr

unique_ptr 的析构函数销毁 unique_ptr 对象。

~unique_ptr();

备注

析构函数调用 get_deleter()(stored_ptr)。