std::inout_ptr_t

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) is_within_lifetime (C++26) 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)

Общие утилиты Дата и время Функциональные объекты Библиотека форматирования (C++20) bitset hash (C++11) Операторы отношения (устарело в 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 ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Общие лексические типы 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) expected (C++23) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

Динамическое управление памятью

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) voidify (C++20) 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::construct_at (C++20) ranges::destroy (C++20) ranges::destroy_n (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 (C++20) ranges::uninitialized_value_construct (C++20) ranges::uninitialized_default_construct_n (C++20)   ranges::uninitialized_value_construct_n (C++20) allocator allocator_traits (C++11) allocation_result (C++23) 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) Поддержка сбора мусора 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) raw_storage_iterator (до C++20*) get_temporary_buffer (до C++20*) return_temporary_buffer (до C++20*) Явное управление временем жизни start_lifetime_asstart_lifetime_as_array (C++23)(C++23)

unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (до C++17*) owner_less (C++11) owner_less<void> (C++17) 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) operator new operator new[] operator delete operator delete[] get_new_handler set_new_handler launder (C++17) bad_alloc bad_array_new_length nothrow_t align_val_t destroying_delete_t new_handler nothrow pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) Библиотека C malloc calloc realloc    aligned_alloc (C++17) free

 

std::inout_ptr_t

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

inout_ptr_t::inout_ptr_t

inout_ptr_t::~inout_ptr_t

inout_ptr_t::operator Pointer*inout_ptr_t::operator void**

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

inout_ptr

 

<tbody> </tbody>

Определено в заголовочном файле <memory>
template< class Smart, class Pointer, class... Args > class inout_ptr_t;		(начиная с C++23)

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 не равно нулю.

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

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

Smart	—	тип объекта (обычно умный указатель) для адаптации
Pointer	—	тип объекта (обычно сырой указатель), к которому обращается внешняя функция для сброса права собственности
Args...	—	тип захваченных аргументов, используемых для сброса адаптированного объекта
Требования к типам
- Pointer должен соответствовать требованиям NullablePointer.
- Программа некорректна, если Smart является специализацией std::shared_ptr.

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

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

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

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

(конструктор) (C++23)	создаёт inout_ptr_t (public функция-элемент)
operator= [удалено](C++23)	inout_ptr_t не может быть присвоен (public функция-элемент)
(деструктор) (C++23)	сбрасывает адаптированный умный указатель после освобождения его владения (public функция-элемент)
operator Pointer*operator void** (C++23)	преобразует inout_ptr_t в адрес хранилища для вывода (public функция-элемент)

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

inout_ptr (C++23)

создаёт 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*, который им необходим.

Макрос Тестирования функциональности	Значение	Стандарт	Функциональность
__cpp_lib_out_ptr	202106L	(C++23)	std::out_ptr, std::inout_ptr

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

out_ptr_t (C++23)	взаимодействует с установщиками внешних указателей и сбрасывает умный указатель при уничтожении (шаблон класса)
unique_ptr (C++11)	умный указатель с уникальной семантикой владения объектом (шаблон класса)
shared_ptr (C++11)	умный указатель с семантикой владения разделяемым объектом (шаблон класса)