std::out_ptr_t

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

工具库

语言支持 类型支持（基本类型、 RTTI 、类型特征）     库功能特性测试宏 (C++20) 动态内存管理 程序工具 错误处理 协程支持 (C++20) 变参数函数 launder (C++17) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 bitset 格式化库 (C++20) hash (C++11) integer_sequence (C++14) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

动态内存管理

智能指针 unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (C++17 前) owner_less (C++11) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) out_ptr_t (C++23) inout_ptr_t (C++23) 分配器 allocator allocator_traits (C++11) allocation_result (C++23) allocate_at_least (C++23) allocator_arg_t (C++11) allocator_arg (C++11) uses_allocator (C++11) uses_allocator_construction_args (C++20) make_obj_using_allocator (C++20) uninitialized_construct_using_allocator (C++20) scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) 内存资源 pmr::memory_resource (C++17) pmr::get_default_resource (C++17) pmr::set_default_resource (C++17) pmr::new_delete_resource (C++17) pmr::null_memory_resource (C++17) pmr::synchronized_pool_resource (C++17) pmr::unsynchronized_pool_resource (C++17) pmr::monotonic_buffer_resource (C++17) pmr::pool_options (C++17) 未初始化存储 raw_storage_iterator (C++20 前) get_temporary_buffer (C++20 前) return_temporary_buffer (C++20 前)

未初始化内存算法 uninitialized_copy uninitialized_fill uninitialized_move (C++17) uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17) destroy_at (C++17) uninitialized_copy_n (C++11) uninitialized_fill_n uninitialized_move_n (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17) construct_at (C++20) 受约束的未初始化内存算法 ranges::uninitialized_copy (C++20) ranges::uninitialized_fill (C++20) ranges::uninitialized_move (C++20) ranges::uninitialized_default_construct (C++20) ranges::uninitialized_value_construct (C++20) ranges::destroy (C++20) ranges::destroy_at (C++20) ranges::uninitialized_copy_n (C++20) ranges::uninitialized_fill_n (C++20) ranges::uninitialized_move_n (C++20) ranges::uninitialized_default_construct_n (C++20) ranges::uninitialized_value_construct_n (C++20) ranges::destroy_n (C++20) ranges::construct_at (C++20) 垃圾收集支持 declare_reachable (C++11)(C++23 前) undeclare_reachable (C++11)(C++23 前) declare_no_pointers (C++11)(C++23 前) undeclare_no_pointers (C++11)(C++23 前) pointer_safety (C++11)(C++23 前) get_pointer_safety (C++11)(C++23 前) 杂项 pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) C 库 malloc aligned_alloc (C++17) calloc realloc free 低层内存管理

 

std::out_ptr_t

成员函数

out_ptr_t::out_ptr_t (C++23)

out_ptr_t::~out_ptr_t (C++23)

out_ptr_t::operator Pointer*out_ptr_t::operator void** (C++23)(C++23)

非成员函数

out_ptr (C++23)

 

定义于头文件 <memory>
template< class Smart, class Pointer, class... Args > class out_ptr_t;		(C++23 起)

out_ptr_t 用于对通过 Pointer* （通常为某对象类型 T 的 T** ）或 void** 参数输出其结果的外来函数，适配智能指针之类的类型。

out_ptr_t 在构造时捕获额外的实参，为前述的这种外来函数写入的结果提供存储，而最终在销毁时以该结果和捕获的实参重设适配的 Smart 对象。

out_ptr_t 表现如同它拥有下列非静态数据成员：

• 一个 Smart& 引用，在构造时绑定到被适配的对象，
• 对 Args... 中的每个 T 有一个 T 类型成员，它是在构造时捕获并在析构时用于重设的实参，以及
• 适合在其内存储 Pointer 以及提供 void* 对象的成员子对象，其中 Pointer 或 void* 对象通常会暴露给用于重初始化的外来函数。

用户能通过在 Args... 中分别指定对象类型或引用类型，控制每个参数是按复制还是按引用捕获。

模板形参

Smart	-	要适配的对象（常为智能指针）的类型
Pointer	-	外来函数写入其结果所用的对象（常为裸指针）的类型
Args...	-	用于重设适配的对象的捕获实参的类型
类型要求
- Pointer 必须满足可空指针 (NullablePointer) 的要求。
- 若 Smart 为 std::shared_ptr 特化且 sizeof...(Args) == 0 则程序非良构。

特化

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

此许可允许程序定义特化将存储于非标准智能指针内的裸指针暴露给外来函数。

成员函数

(构造函数) (C++23)	构造 out_ptr_t (公开成员函数)
operator= [被删除](C++23)	out_ptr_t 不可赋值 (公开成员函数)
(析构函数) (C++23)	重设适配的智能指针 (公开成员函数)
operator Pointer*operator void** (C++23)	转换 out_ptr_t 为用于输出的存储的地址 (公开成员函数)

非成员函数

out_ptr (C++23)

以关联的智能指针和重设参数创建 out_ptr_t (函数模板)

注解

out_ptr_t 期待外来函数不使用被指向的 Pointer 的值并且只重新初始化它。不使用智能指针在适配前的值。

out_ptr_t 的典型用法是由 std::out_ptr 创建其临时对象，这会立即重设智能指针。例如，给定设置器函数和智能指针，分别以 int foreign_setter(T**); 与 std::unique_ptr<T, D> up; 声明，

if (int ec = foreign_setter(std::out_ptr(up)) {
    return ec;
}

粗略地等价于

T *raw_p{};
int ec = foreign_setter(&raw_p);
up.reset(raw_p);
if (ec != 0) {
    return ec;
}

不推荐创建拥有自动存储期以外的存储期的 out_ptr_t 对象，因为这种代码较可能产生悬垂引用并在析构时导致未定义行为。

out_ptr_t 禁止会不经指定删除器就重设 std::shared_ptr 的用法，因为之后它会调用 std::shared_ptr::reset 并替换定制的删除器。

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

参阅

inout_ptr_t (C++23)	与外来指针设置器交互，从智能指针获得初始指针值，并在析构时重设它 (类模板)
unique_ptr (C++11)	拥有独有对象所有权语义的智能指针 (类模板)
shared_ptr (C++11)	拥有共享对象所有权语义的智能指针 (类模板)