命名空间
变体
操作

std::out_ptr

来自 cppreference.cn
< cpp‎ | 内存‎ | out ptr t
 
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::out_ptr_t
 
定义于头文件 <memory>
template< class Pointer = void, class Smart, class... Args >
auto out_ptr( Smart& s, Args&&... args );
 (C++23 起)

返回一个带有推导模板参数的 std::out_ptr_t，它通过引用捕获重置参数。

如果返回值的构造（见下文）格式错误，则程序格式错误。

目录

[编辑] 参数

s - 要适配的对象（通常是智能指针）
args... - 要捕获的重置参数

[编辑] 返回值

std::out_ptr_t<Smart, P, Args&&>(s, std::forward<Args>(args)...)，其中 P 是

  • Pointer，如果 Pointer 与 void 不同。否则，
  • Smart::pointer，如果它有效并表示一个类型。否则，
  • Smart::element_type*，如果 Smart::element_type 有效并表示一个类型。否则，
  • std::pointer_traits<Smart>::element_type*.

[编辑] 注意

用户可以为模板参数 Pointer 指定模板参数，以便与接受 Pointer* 的外部函数进行互操作。

由于所有重置参数都是通过引用捕获的，因此返回的 out_ptr_t 应该是一个临时对象，并在包含对外部函数调用的完整表达式结束时销毁，以避免悬空引用。

特性测试宏 值 标准 特性
__cpp_lib_out_ptr 202106L (C++23) std::out_ptr, std::inout_ptr
202311L (C++26) 独立的 std::out_ptr 和 std::inout_ptr

[编辑] 示例

使用 std::out_ptr 适配智能指针以用于 sqlite3_open，它需要一个 sqlite3** 作为输出参数。

运行此代码
#include <memory>
#include <sqlite3.h>
 
int main()
{
    auto close_db = [](sqlite3* db) { sqlite3_close(db); };
 
    {
        // open an in-memory database, and manage its lifetime with std::unique_ptr
        std::unique_ptr<sqlite3, decltype(close_db)> up;
        sqlite3_open(":memory:", std::out_ptr(up));
 
        sqlite3* db = up.get();
        // do something with db ...
    }
    {
        // same as above, but use a std::shared_ptr
        std::shared_ptr<sqlite3> sp;
        sqlite3_open(":memory:", std::out_ptr(sp, close_db));
 
        sqlite3* db = sp.get();
        // do something with db ...
    }
}

[编辑] 另请参阅

(C++23)
 创建一个带有关联智能指针和重置参数的 inout_ptr_t
(函数模板) [编辑]
(C++14)(C++20)
 创建一个管理新对象的唯一指针
(函数模板) [编辑]
(C++20 起)
 创建一个管理新对象的共享指针
(函数模板) [编辑]
取自 "https://cppreference.cn/mwiki/index.php?title=cpp/memory/out_ptr_t/out_ptr&oldid=166748"