std::inout_ptr_t<Smart,Pointer,Args...>::inout_ptr_t

From cppreference.com

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros(C++20)
Language support library
Concepts library(C++20)
Diagnostics library
Memory management library
Metaprogramming library(C++11)
General utilities library
Containers library
Iterators library
Ranges library(C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library(C++17)
Concurrency support library(C++11)
Execution control library(C++26)
Technical specifications
Symbols index
External libraries

[edit]

Memory management library

voidify

(exposition only*)

Allocators

allocator
allocator_traits (C++11)
allocation_result (C++23)
scoped_allocator_adaptor (C++11)
pmr::polymorphic_allocator (C++17)

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)

Uninitialized memory algorithms

uninitialized_copy
uninitialized_fill
uninitialized_move (C++17)
uninitialized_copy_n (C++11)
uninitialized_fill_n
uninitialized_move_n (C++17)
construct_at (C++20)

uninitialized_default_construct (C++17)
uninitialized_value_construct (C++17)
destroy (C++17)
uninitialized_default_construct_n (C++17)
uninitialized_value_construct_n (C++17)
destroy_n (C++17)
destroy_at (C++17)

Constrained uninitialized memory algorithms

ranges::uninitialized_copy (C++20)
ranges::uninitialized_fill (C++20)
ranges::uninitialized_move (C++20)
ranges::uninitialized_copy_n (C++20)
ranges::uninitialized_fill_n (C++20)
ranges::uninitialized_move_n (C++20)
ranges::construct_at (C++20)

ranges::uninitialized_default_construct (C++20)
ranges::uninitialized_value_construct (C++20)
ranges::destroy (C++20)
ranges::uninitialized_default_construct_n (C++20)
ranges::uninitialized_value_construct_n (C++20)
ranges::destroy_n (C++20)
ranges::destroy_at (C++20)

Memory resources

pmr::memory_resource (C++17)
pmr::get_default_resource (C++17)
pmr::set_default_resource (C++17)
pmr::new_delete_resource (C++17)
pmr::pool_options (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)

Explicit lifetime management
start_lifetime_as (C++23)
start_lifetime_as_array (C++23)

Types for composite class design
indirect (C++26)
polymorphic (C++26)

Uninitialized storage(until C++20)

raw_storage_iterator (until C++20*)
get_temporary_buffer (until C++20*)

return_temporary_buffer (until C++20*)

Garbage collector support(until C++23)

declare_reachable (C++11)(until C++23)
declare_no_pointers (C++11)(until C++23)
pointer_safety (C++11)(until C++23)

undeclare_reachable (C++11)(until C++23)
undeclare_no_pointers (C++11)(until C++23)
get_pointer_safety (C++11)(until C++23)

Low level memory
management

operator newoperator new[]

operator deleteoperator delete[]

(C++11)

(C++11)

(C++17)

(C++20)

(C++17)

(C++11)

(C++11)

(C++11)

(until C++17*)

(C++11)

(C++17)

(C++26)

(C++26)

enable_shared_from_this

(C++11)

(C++11)

(C++11)

(C++23)

(C++23)

(C++11)

(C++20)

(C++11)

(C++11)

(C++20)

is_sufficiently_aligned

(C++26)

C Library

malloc
calloc
realloc

free
aligned_alloc (C++17)

[edit]

std::inout_ptr_t

Member functions
inout_ptr_t::inout_ptr_t
inout_ptr_t::~inout_ptr_t
inout_ptr_t::operator Pointerinout_ptr_t::operator void*
Non-member functions
inout_ptr

[edit]

explicit inout_ptr_t( Smart&sp, Args...args);	(1)	(since C++23)
inout_ptr_t(const inout_ptr_t&)= delete;	(2)	(since C++23)

1) Creates aninout_ptr_t. Adaptssp as if binds it to theSmart& member, captures every argumentt inargs... as if initializes the corresponding member of typeT inArgs... withstd::forward<T>(t), then initializes the storedPointer withsp ifSmart is a pointer type, otherwise, initializes it withsp.get().sp.release() may be called ifSmart is not a pointer type, in which case it will not be called again within the destructor.

2) Copy constructor is explicitly deleted.inout_ptr_t is neither copyable nor movable.

[edit]Parameters

sp	-	the object (typically a smart pointer) to adapt
args...	-	the arguments used for resetting to capture

[edit]Return value

(none)

[edit]Exceptions

May throw implementation-defined exceptions.

[edit]Notes

IfSmart is not a pointer type andsp.release() is not called by the constructor, it may be called by the destructor before resettingsp.

Every argument inargs... is moved into the createdinout_ptr_t if it is of an object type, or transferred into the createdinout_ptr_t as-is if it is of a reference type.

The constructor ofinout_ptr_t is allowed to throw exceptions. For example, whensp is an intrusive pointer with a control block, the allocation for the new control block may be performed within the constructor rather than the destructor.