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

 

C++

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

 

Memory management library

Allocators allocator allocator_traits (C++11) allocation_result (C++23) scoped_allocator_adaptor (C++11) allocator_arg (C++11) uses_allocator (C++11) uses_allocator_construction_args (C++20) make_obj_using_allocator (C++20) pmr::polymorphic_allocator (C++17) uninitialized_construct_using_allocator (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) Miscellaneous pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) is_sufficiently_aligned (C++26) C Library malloc      free calloc realloc aligned_alloc (C++17) free_sized (C++26) free_aligned_sized (C++26) memalignment (C++26) Uninitialized storage (until C++20*) raw_storage_iterator get_temporary_buffer return_temporary_buffer Garbage collector support (until C++23) declare_reachable (C++11) declare_no_pointers (C++11) pointer_safety (C++11) undeclare_reachable (C++11) undeclare_no_pointers (C++11) get_pointer_safety (C++11)

Specialized <memory> algorithms Low level memory management operator newoperator new[] operator deleteoperator delete[] nothrow nothrow_t new_handler set_new_handler get_new_handler (C++11) bad_alloc bad_array_new_length (C++11) align_val_t (C++17) destroying_delete_t (C++20) launder (C++17) Smart pointers unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (until C++17*) owner_less (C++11) owner_less<void> (C++17) owner_hash (C++26) owner_equal (C++26) 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)

 

std::out_ptr_t

Member functions

out_ptr_t::out_ptr_t

out_ptr_t::~out_ptr_t

out_ptr_t::operator Pointer*out_ptr_t::operator void**

Non-member functions

out_ptr

 

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

1) Creates an out_ptr_t.

• Adapts sp as if binds it to the Smart& member, captures every argument t in args as if initializes the corresponding member of type T in Args with std::forward<T>(t), then value-initializes the stored Pointer.
• Then evaluates sp.reset() if the expression is well-formed; otherwise, evaluates sp = Smart() if std::is_default_constructible_v<Smart> is true. If both resetting operations are ill-formed, the program is ill-formed.

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

Parameters

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

Exceptions

May throw implementation-defined exceptions.

Notes

After construction, the Pointer or void* object pointed by the return value of either conversion function is equal to nullptr.

Every argument in args is moved into the created out_ptr_t if it is of an object type, or transferred into the created out_ptr_t as-is if it is of a reference type.

The constructor of out_ptr_t is allowed to throw exceptions. For example, when sp is a std::shared_ptr, the allocation for the new control block may be performed within the constructor rather than the destructor.