std::out_ptr_t — cppreference.com

<tbody> </tbody>

out_ptr_t используется для адаптации типов, таких как умные указатели, для внешних функций, которые выводят свои результаты через Pointer* (обычно T** для некоторого типа объекта T) или параметр void**.

out_ptr_t захватывает дополнительные аргументы при построении, обеспечивает хранилище для результата, в который записывается такая вышеупомянутая внешняя функция, и, наконец, сбрасывает адаптированный объект Smart с результатом и захваченными аргументами, когда он уничтожается.

out_ptr_t ведёт себя так, как будто он содержит следующие нестатические элементы данных:

• ссылка Smart&, которая привязывается к адаптированному объекту при построении,
• для каждого T в Args... элемент типа T, который является аргументом, захваченным при построении и используемым для сброса при уничтожении, и
• подобъект-элемент, подходящий для хранения в нём Pointer и предоставления объекта void*, где объект Pointer или void* обычно открывается внешней функции для повторной инициализации.

Пользователи могут контролировать, захватывается ли каждый аргумент для сброса копией или ссылкой, указав тип объекта или тип ссылки в Args... соответственно.

Параметры шаблона

Специализации

В отличие от большинства шаблонов классов в стандартной библиотеке, программно-определяемые специализации out_ptr_t, которые зависят по крайней мере от одного программно-определяемого типа, не обязательно должны соответствовать требованиям основного шаблона.

Эта разрешение позволяет программно-определяемой специализации предоставлять сырой указатель, хранящийся в нестандартном умном указателе, внешним функциям.

Функции-элементы

Функции, не являющиеся элементами

Примечание

out_ptr_t ожидает, что сторонние функции не используют значение, на которое указывает Pointer, а только повторно инициализируют его. Значение умного указателя до адаптации не используется.

Типичное использование out_ptr_t это создание временных объектов с помощью std::out_ptr, что немедленно сбрасывает адаптированный умный указатель. Например, учитывая функцию установки и умный указатель соответствующего типа, объявленные с помощью int foreign_setter(T**); и std::unique_ptr<T, D> up; соответственно,

int foreign_setter(T**);
std::unique_ptr<T, D> up;

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

примерно эквивалентно

int foreign_setter(T**);
std::unique_ptr<T, D> up;
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*, который им необходим.

Пример

Смотрите также