Spec-Zone.ru › C++

std::out_ptr

Определён в заголовочном файле <memory>
template< class Pointer = void, class Smart, class... Args >
auto out_ptr( Smart& s, Args&&... args );
(начиная с C++23)
(constexpr начиная с C++26)

Возвращает 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 для freestanding-реализаций
__cpp_lib_constexpr_memory 202506L (C++26) std::out_ptr с вычислениями constexpr

Пример

Использует 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 ...
    }
}

См. также

inout_ptr
(C++23)
создаёт inout_ptr_t со связанным интеллектуальным указателем и аргументами для сброса
(шаблон функции)
make_uniquemake_unique_for_overwrite
(C++14)(C++20)
создаёт уникальный указатель, управляющий новым объектом
(шаблон функции)
make_sharedmake_shared_for_overwrite
(C++20)
создаёт разделяемый указатель, управляющий новым объектом
(шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/memory/out_ptr_t/out_ptr

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API