std::basic_basic_string<CharT,Traits,Allocator>::assign

 

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)

 

basic_string& assign( const basic_string& str );	(1)	(C++20 以降 constexpr)
basic_string& assign( basic_string&& str ) noexcept(/* 参照 */);	(2)	(C++11以降) (C++20 以降 constexpr)
basic_string& assign( size_type count, CharT ch );	(3)	(C++20 以降 constexpr)
basic_string& assign( const CharT* s, size_type count );	(4)	(C++20 以降 constexpr)
basic_string& assign( const CharT* s );	(5)	(C++20 以降 constexpr)
template< class SV > basic_string& assign( const SV& t );	(6)	(C++17以降) (C++20 以降 constexpr)
template< class SV > basic_string& assign( const SV& t,                       size_type pos, size_type count = npos);	(7)	(C++17以降) (C++20 以降 constexpr)
	(8)
basic_string& assign( const basic_string& str,                       size_type pos, size_type count );			(C++14まで)
basic_string& assign( const basic_string& str,                       size_type pos, size_type count = npos);			(C++14以降) (C++20 以降 constexpr)
template< class InputIt > basic_string& assign( InputIt first, InputIt last );		(9)	(C++20 以降 constexpr)
basic_string& assign( std::initializer_list<CharT> ilist );		(10)	(C++11以降) (C++20 以降 constexpr)

文字列の内容を置き換えます。

1) return *this = str; と同等です。

2) return *this = std::move(str); と同等です。

3) 内容を文字 ch の count 回のコピーで置き換えます。

clear(); resize(n, c); return *this; と同等です。

4) 内容を範囲 [s, s + count) の文字のコピーで置き換えます。

範囲[s, s + count)が有効な範囲でない場合、動作は未定義です。

5) return assign(s, Traits::length(s)); と同等です。

6,7) 文字列ビュー sv から構築された t の文字で内容を置き換えます。

• t のみが提供されている場合、sv のすべての文字で内容を置き換えます。
• pos も提供されている場合
  • count が npos の場合、sv の pos から始まるすべての文字で内容を置き換えます。
  • それ以外の場合、sv の pos から始まる std::min(count, sv.size() - pos) 文字で内容を置き換えます。

これらのオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加する。

• std::is_convertible_v<const SV&, std::basic_string_view<CharT, Traits>> は true です。
• std::is_convertible_v<const SV&, const CharT*> は false です。

6) std::basic_string_view<CharT, Traits> sv = t;
return assign(sv.data(), sv.size()); と同等です。

7) std::basic_string_view<CharT, Traits> sv = t;
return assign(sv.substr(pos, count)); と同等です。

8) str の文字で内容を置き換えます。

• count が npos の場合、str の pos から始まるすべての文字で内容を置き換えます。
• それ以外の場合、str の pos から始まる std::min(count, str.size() - pos) 文字で内容を置き換えます。

return assign(std::basic_string_view<CharT, Traits>                   (str).substr(pos, count)); と同等です。

(C++20以降)

9) return assign(basic_string(first, last, get_allocator())); と同等です。

このオーバーロードは、 InputIt が LegacyInputIterator の要件を満たす場合にのみ、オーバーロード解決に参加します。

(C++11以降)

10) return assign(ilist.begin(), ilist.size()); と同等です。

パラメータ

str	-	初期化に使用する文字列
count	-	結果の文字列のサイズ
文字	-	文字列の初期化に使用する文字の値
s	-	文字列の初期化に使用する文字配列へのポインタ
t	-	初期化に使用するオブジェクト (std::basic_string_view に変換可能)
pos	-	取得する最初の文字のインデックス
first, last	-	文字をコピーする範囲
ilist	-	初期化に使用する std::initializer_list

戻り値

*this

例外

2)

noexcept 指定:  

noexcept(std::allocator_traits<Allocator>::

             propagate_on_container_move_assignment::value ||

         std::allocator_traits<Allocator>::is_always_equal::value)

操作によりsize()がmax_size()を超える場合、std::length_errorを送出します。

7) pos > sv.size() が true の場合、std::out_of_range をスローします。

8) pos > str.size() が true の場合、std::out_of_range をスローします。

何らかの理由で例外がスローされた場合、この関数は効果がありません（強力な例外安全保証）。

例

このコードを実行

#include <iostream>
#include <iterator>
#include <string>
 
int main()
{
    std::string s;
    // assign(size_type count, CharT ch)
    s.assign(4, '=');
    std::cout << s << '\n'; // "===="
 
    std::string const c("Exemplary");
    // assign(const basic_string& str)
    s.assign(c);
    std::cout << c << " == " << s << '\n'; // "Exemplary == Exemplary"
 
    // assign(const basic_string& str, size_type pos, size_type count)
    s.assign(c, 0, c.length() - 1);
    std::cout << s << '\n'; // "Exemplar";
 
    // assign(basic_string&& str)
    s.assign(std::string("C++ by ") + "example");
    std::cout << s << '\n'; // "C++ by example"
 
    // assign(const CharT* s, size_type count)
    s.assign("C-style string", 7);
    std::cout << s << '\n'; // "C-style"
 
    // assign(const CharT* s)
    s.assign("C-style\0string");
    std::cout << s << '\n'; // "C-style"
 
    char mutable_c_str[] = "C-style string";
    // assign(InputIt first, InputIt last)
    s.assign(std::begin(mutable_c_str), std::end(mutable_c_str) - 1);
    std::cout << s << '\n'; // "C-style string"
 
    // assign(std::initializer_list<CharT> ilist)
    s.assign({'C', '-', 's', 't', 'y', 'l', 'e'});
    std::cout << s << '\n'; // "C-style"
}

出力

====
Exemplary == Exemplary
Exemplar
C++ by example
C-style
C-style
C-style string
C-style

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 847	C++98	例外安全性保証がなかった	強力な例外安全性保証を追加
LWG 2063	C++11	非標準的な注記により、オーバーロード (2) は スワップによって実装できるとされていました。	ムーブ代入が必要なように修正されました。
LWG 2250	C++98	オーバーロード (8) の動作は pos > str.size() が true の場合、未定義でした。	この場合、常に例外をスローします。
LWG 2579	C++98	オーバーロード (1) とコピー代入 演算子には異なる効果がありました。	それらは同じ効果を持つようになりました。
LWG 2946	C++17	オーバーロード (6) は、一部のケースで曖昧さを引き起こしました。	テンプレートにすることで回避されました。

関連項目

assign_range (C++23)	文字列への文字範囲の代入 (public member function)
(コンストラクタ)	basic_string を構築する (public member function)
operator=	文字列に値を代入する (public member function)