命名空间
变体
操作

std::inout_ptr_t

来自 cppreference.cn
< cpp‎ | memory
 
C++
 
内存管理库
(仅为阐释目的*)
未初始化内存算法
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++17)
(C++17)
(C++17)
(C++20)
受约束的未初始化
内存算法
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20) 
(C++20)
C 库

分配器
(C++11)
(C++23)
(C++11)
(C++11)
(C++20)
(C++20)
(C++20) 
(C++11)
(C++17)
内存资源
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
垃圾回收支持
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
未初始化存储
(直到 C++20*)
(直到 C++20*)
(直到 C++20*)
显式生命周期管理
(C++23)(C++23)
 
std::inout_ptr_t
 
定义于头文件 <memory>
template< class Smart, class Pointer, class... Args >
class inout_ptr_t;
 (自 C++23 起)

inout_ptr_t 用于适配智能指针等类型，以用于通过 Pointer*（通常对于某些对象类型 T 为 T**）或 void** 参数重置所有权的外部函数。

inout_ptr_t 在构造时捕获额外的参数，为这种前述的外部函数访问的结果提供存储，释放适配的 Smart 对象所持有的所有权，并在销毁时最终使用结果和捕获的参数重置适配的 Smart 对象。

inout_ptr_t 的行为如同它持有以下非静态数据成员

  • 一个 Smart& 引用，在构造时绑定到适配的对象，
  • 对于 Args... 中的每个 T，一个 T 类型的成员，这是在构造时捕获并在销毁时用于重置的参数，以及
  • 一个成员子对象，适合于在其内部存储 Pointer 并提供一个 void* 对象，其中 Pointer 或 void* 对象通常暴露给外部函数以进行所有权重置。

如果 Smart 不是指针类型，则在适配的对象上最多调用一次 release()。如果 Pointer 值不为空，则实现可以在构造函数内或在析构函数内重置之前调用 release()。

用户可以通过在 Args... 中分别指定对象类型或引用类型来控制每个用于重置的参数是按复制捕获还是按引用捕获。

目录

[编辑] 模板形参

Smart - 要适配的对象类型（通常为智能指针）
Pointer - 外部函数访问以进行所有权重置的对象类型（通常为原始指针）
Args... - 用于重置适配对象的捕获参数类型
类型要求
-
Pointer 必须满足 NullablePointer 的要求。
-
如果 Smart 是 std::shared_ptr 特化，则程序为非良构。

[编辑] 特化

与标准库中的大多数类模板不同，依赖于至少一个程序定义的类型 的 inout_ptr_t 的 程序定义的特化 不需要满足主模板的要求。

此许可允许程序定义的特化将非标准智能指针中存储的原始指针暴露给外部函数。

[编辑] 成员函数

(C++23)
 构造 inout_ptr_t
(公有成员函数)
operator=
[已删除](C++23)
 inout_ptr_t 不可赋值
(公有成员函数)
(C++23)
 在释放所有权后重置适配的智能指针
(公有成员函数)
(C++23)
 将 inout_ptr_t 转换为输出存储的地址
(公有成员函数)

[编辑] 非成员函数

(C++23)
 使用关联的智能指针和重置参数创建 inout_ptr_t
(函数模板) [编辑]

[编辑] 注解

inout_ptr_t 期望外部函数释放由指向的 Pointer 的值表示的所有权，然后重新初始化它。由于此类操作需要唯一所有权，因此禁止与 std::shared_ptr 一起使用。

inout_ptr_t 的典型用法是通过 std::inout_ptr 创建其临时对象，这将立即重置适配的智能指针。例如，给定一个 setter 函数和一个使用 int foreign_resetter(T**); 和 std::unique_ptr<T, D> up; 分别声明的适当类型的智能指针，

if (int ec = foreign_resetter(std::inout_ptr(up)))
    return ec;

大致等价于

T *raw_p = up.get();
up.release();
int ec = foreign_resetter(&raw_p);
up.reset(raw_p);
if (ec != 0)
    return ec;

不建议创建除自动存储期以外的存储期的 inout_ptr_t 对象，因为此类代码很可能产生悬空引用，并在销毁时导致未定义行为。

捕获的参数通常被打包到 std::tuple<Args...> 中。实现可以使用不同的机制来提供他们需要持有的 Pointer 或 void* 对象。


特性测试 宏 值 Std 特性
__cpp_lib_out_ptr 202106L (C++23) std::out_ptr, std::inout_ptr
202311L (C++26) 自由 freestanding std::out_ptr 和 std::inout_ptr

[编辑] 示例

本节不完整
原因：没有示例

[编辑] 参见

(C++23)
 与外部指针 setter 互操作并在销毁时重置智能指针
(类模板) [编辑]
(C++11)
 具有唯一对象所有权语义的智能指针
(类模板) [编辑]
(C++11)
 具有共享对象所有权语义的智能指针
(类模板) [编辑]
取自“https://cppreference.cn/mwiki/index.php?title=cpp/memory/inout_ptr_t&oldid=170143”