std::basic_string<CharT,Traits,Allocator>::resize_and_overwrite

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

文字列ライブラリ

クラス

basic_string

basic_string_view (C++17)

char_traits

 

std::basic_string

メンバ関数 basic_string::basic_string basic_string::~basic_string basic_string::operator= basic_string::assign basic_string::assign_range (C++23)   basic_string::get_allocator 要素アクセス basic_string::at basic_string::operator[] basic_string::front (DR*) basic_string::back (DR*) basic_string::data basic_string::c_str basic_string::operator  basic_string_view (C++17) イテレータ basic_string::beginbasic_string::cbegin (C++11) basic_string::endbasic_string::cend (C++11) basic_string::rbeginbasic_string::crbegin (C++11) basic_string::rendbasic_string::crend (C++11) 検索 basic_string::find basic_string::rfind basic_string::find_first_of basic_string::find_first_not_of basic_string::find_last_of basic_string::find_last_not_of

変更 basic_string::clear basic_string::insert basic_string::insert_range (C++23) basic_string::erase basic_string::push_back basic_string::pop_back (DR*) basic_string::append basic_string::append_range (C++23) basic_string::operator+= basic_string::replace basic_string::replace_with_range (C++23) basic_string::copy basic_string::resize basic_string::resize_and_overwrite (C++23)  basic_string::swap 容量 basic_string::empty basic_string::sizebasic_string::length basic_string::max_size basic_string::reserve basic_string::capacity basic_string::shrink_to_fit (DR*) 操作 basic_string::compare basic_string::starts_with (C++20) basic_string::ends_with (C++20) basic_string::contains (C++23) basic_string::substr

定数 basic_string::npos 非メンバ関数 operator+ swap(std::basic_string) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) I/O operator<<operator>> getline 比較 operator==operator!=operator<operator>operator<=operator>=operator<=> (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20) 数値変換 stoistolstoll (C++11)(C++11)(C++11) stoulstoull (C++11)(C++11)  stofstodstold (C++11)(C++11)(C++11) to_string (C++11) to_wstring (C++11) リテラル operator""s (C++14) ヘルパークラス hash<std::basic_string> (C++11) 推論ガイド (C++17)

 

template< class Operation > constexpr void resize_and_overwrite( size_type count, Operation op );		(C++23から)

この関数は、最大で count 文字を保持するように文字列のサイズを変更し、ユーザーが提供する操作 op を使用して、おそらく不確定な内容を変更し、長さを設定します。これにより、たとえば C API 呼び出しによって設定されることを意図した char 配列として使用される場合、適切なサイズの std::string を初期化するコストを回避できます。

この関数は以下の手順を実行します。

1. count + 1 文字を含む連続したストレージを取得し、その最初の k 文字を *this の最初の k 文字と同じにします。ここで k は、count と resize_and_overwrite を呼び出す前の size() の結果のうち小さい方です。ストレージの最初の文字へのポインタを p とします。
   • 等価性は、this->compare(0, k, p, k) == 0 をチェックすることで決定されるかのように行われます。
   • [p + k, p + count] の文字は不確定な値を持つ場合があります。
2. std::move(op)(p, count) を評価し、その戻り値を r とします。
3. *this の内容を [p, p + r) で置き換えます (*this の長さを r に設定します)。範囲 [p, p + count] へのすべてのポインタと参照を無効にします。

r が integer-like 型でない場合、プログラムは不正です。

次のいずれかの条件が満たされる場合、動作は未定義です。

• std::move(op)(p, count) が例外をスローします。
• std::move(op)(p, count) が p または count を変更します。
• r が範囲 [​0​, count] にありません。
• 範囲 [p, p + r) の文字は不確定な値を持っています。

実装は、たとえば、呼び出し後に *this に割り当てられた文字のストレージの先頭へのポインタと p を等しくすることで、不要なコピーと割り当てを避けることが推奨されます。これは、count が capacity() 以下の場合、*this の既存のストレージと同じである可能性があります。

パラメータ

count	-	文字列の新しい最大可能なサイズ
op	-	文字列の新しい内容を設定するために使用される関数オブジェクト

例外

count > max_size() の場合、std::length_error。対応する Allocator によってスローされるすべての例外。

std::move(op)(p, count) から例外がスローされた場合、動作は未定義です。それ以外の場合、例外がスローされても、この関数は影響を与えません。

備考

resize_and_overwrite は、再割り当てが発生するかどうかに関わらず、*this 内のすべてのイテレータ、ポインタ、および参照を無効にします。実装は、resize_and_overwrite 呼び出し後に文字列の内容がエイリアスされないと仮定することができます。

機能テストマクロ	値	規格	機能
__cpp_lib_string_resize_and_overwrite	202110L	(C++23)	std::basic_string::resize_and_overwrite

例

例をテストするためのリンク: compiler explorer。

このコードを実行

#include <algorithm>
#include <cassert>
#include <cstddef>
#include <cstring>
#include <iomanip>
#include <iostream>
#include <string>
#include <string_view>
static_assert(__cpp_lib_string_resize_and_overwrite);
 
constexpr std::string_view fruits[]{"apple", "banana", "coconut", "date", "elderberry"};
 
int main()
{
    // A simple case, append only fruits[0]. The string size will be increased.
    std::string s{"Food: "};
    s.resize_and_overwrite(16, [sz = s.size()](char* buf, std::size_t buf_size) noexcept
    {
        const auto to_copy = std::min(buf_size - sz, fruits[0].size());
        std::memcpy(buf + sz, fruits[0].data(), to_copy);
        return sz + to_copy;
    });
    std::cout << "1. " << std::quoted(s) << '\n';
 
    // The size shrinking case. Note, that the user's lambda is always invoked.
    s.resize_and_overwrite(10, [](char* buf, int n) noexcept
    {
        return std::find(buf, buf + n, ':') - buf;
    });
    std::cout << "2. " << std::quoted(s) << '\n';
 
    std::cout << "3. Copy data until the buffer is full. Print data and sizes.\n";
    std::string food{"Food:"};
    const auto resize_to{27};
    std::cout << "Initially, food.size: " << food.size()
              << ", food.capacity: " << food.capacity()
              << ", resize_to: " << resize_to
              << ", food: " << std::quoted(food) << '\n';
 
    food.resize_and_overwrite
    (
        resize_to,
        [food_size = food.size()](char* p, std::size_t n) noexcept -> std::size_t
        {
            // p[0]..p[n] is the assignable range
            // p[0]..p[min(n, food_size) - 1] is the readable range
            // (contents initially equal to the original string)
 
            // Debug print:
            std::cout << "In Operation(); n: " << n << '\n';
 
            // Copy fruits to the buffer p while there is enough space.
            char* first = p + food_size;
 
            for (char* const end = p + n; const std::string_view fruit : fruits)
            {
                char* last = first + fruit.size() + 1;
                if (last > end)
                    break;
                *first++ = ' ';
                std::ranges::copy(fruit, first);
                first = last;
            }
 
            const auto final_size{static_cast<std::size_t>(first - p)};
 
            // Debug print:
            std::cout << "In Operation(); final_size: " << final_size << '\n';
 
            assert(final_size <= n);
            return final_size; // Return value is the actual new length
                               // of the string, must be in range 0..n
        }
    );
 
    std::cout << "Finally, food.size: " << food.size()
              << ", food.capacity: " << food.capacity()
              << ", food: " << std::quoted(food) << '\n';
}

実行結果の例

1. "Food: apple"
2. "Food"
3. Copy data until the buffer is full. Print data and sizes.
Initially, food.size: 5, food.capacity: 15, resize_to: 27, food: "Food:"
In Operation(); n: 27
In Operation(); final_size: 26
Finally, food.size: 26, food.capacity: 30, food: "Food: apple banana coconut"

関連項目

resize

格納されている文字数を変更する (public member function)