std::return_temporary_buffer

 

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

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[] nothrow_t nothrow 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) 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 calloc realloc free aligned_alloc (C++17)

 

Defined in header <memory>
template<class T > void return_temporary_buffer( T* p );		(deprecated in C++17) (removed in C++20)

Deallocates the storage referenced by p.

If p is not a pointer value returned by an earlier call to std::get_temporary_buffer, or has been invalidated by an intervening std::return_temporary_buffer call, the behavior is undefined.

Parameters

p

-

the pointer referring to the storage to be declloated

Return value

(none)

Exceptions

Throws nothing.

Example

Run this code

#include <algorithm>#include <iostream>#include <iterator>#include <memory>#include <string>   int main(){conststd::string s[]={"string", "1", "test", "..."};constauto p =std::get_temporary_buffer<std::string>(4);// requires that p.first is passed to return_temporary_buffer// (beware of early exit points and exceptions), or better use:std::unique_ptr<std::string, void(*)(std::string*)> on_exit(p.first, [](std::string* p){std::cout<<"returning temporary buffer...\n"; std::return_temporary_buffer(p);});   std::copy(s, s + p.second, std::raw_storage_iterator<std::string*, std::string>(p.first));// has same effect as: std::uninitialized_copy(s, s + p.second, p.first);// requires that each string in p is individually destroyed// (beware of early exit points and exceptions)   std::copy(p.first, p.first+ p.second, std::ostream_iterator<std::string>{std::cout, "\n"});   std::for_each(p.first, p.first+ p.second, [](std::string& e){ e.~basic_string<char>();});// same as: std::destroy(p.first, p.first + p.second);   // manually reclaim memory if unique_ptr-like technique is not used:// std::return_temporary_buffer(p.first);}

Output:

string 1 test ... returning temporary buffer...

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 2072	C++98	the storage allocated by std::get_temporary_buffer could be deallocated multiple times	the behavior is undefined in this case

See also

get_temporary_buffer (deprecated in C++17)(removed in C++20)

obtains uninitialized storage (function template)