std::inout_ptr_t

template< class Smart, class Pointer, class... Args >
class inout_ptr_t;

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

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

inout_ptr_t ведёт себя так, как если бы содержал следующие нестатические данные-члены:

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

Если Smart не является типом указателя, release() вызывается для адаптированного объекта не более одного раза. Реализации могут вызывать release() в конструкторе или перед сбросом в деструкторе, если значение Pointer не равно null.

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

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

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

В отличие от большинства шаблонов классов стандартной библиотеки, специализации, определённые программой, для inout_ptr_t, зависящие как минимум от одного типа, определённого программой, не обязаны удовлетворять требованиям к первичному шаблону.

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

Функции-члены

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

Примечания

inout_ptr_t предполагает, что внешние функции освобождают владение, представленное значением объекта Pointer, на который указывает указатель, а затем повторно инициализируют его. Поскольку такая операция требует единоличного владения, использование с std::shared_ptr запрещено.

Обычно inout_ptr_t используют, создавая временные объекты с помощью std::inout_ptr, что немедленно сбрасывает адаптированный умный указатель. Например, если заданы функция-сеттер и умный указатель подходящего типа, объявленные с помощью 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*, который им необходимо удерживать.

Пример

См. также