std::basic_string

ヘッダ `<string>` で定義
template< class CharT, class Traits = std::char_traits<CharT>, class Allocator = std::allocator<CharT> > class basic_string;	(1)
namespace pmr { template< class CharT, class Traits = std::char_traits<CharT> > using basic_string = std::basic_string<CharT, Traits, std::pmr::polymorphic_allocator<CharT>>; }	(2)	(C++17以降)

クラステンプレート basic_string は、文字のようなオブジェクトのシーケンスを格納し、操作します。これはTrivialTypeかつStandardLayoutTypeの非配列オブジェクトです。このクラスは、文字型にもその型に対する操作の性質にも依存しません。操作の定義は、Traits テンプレートパラメータ（std::char_traits の特殊化または互換性のある traits クラス）を介して提供されます。

basic_string の要素は連続して格納されます。つまり、basic_string s に対して、[0, s.size()) の任意の n について &*(s.begin() + n) == &*s.begin() + n であり、*(s.begin() + s.size()) は CharT() の値を持ちます（ヌル終端文字）(C++11以降)。あるいは、同等のこととして、s[0] へのポインタは、CharT の配列(C++11まで)ヌル終端配列(C++11以降) の最初の要素へのポインタを期待する関数に渡すことができます。

std::basic_string は、AllocatorAwareContainer（ただし、要素の構築/破棄にカスタマイズされた construct/destroy は使用されません）、SequenceContainer、および ContiguousContainer(C++17以降)の要件を満たします。

Traits::char_type と Allocator::char_type のいずれかが CharT と異なる場合、プログラムは不適格となります。

std::basic_string のすべてのメンバ関数は constexpr です：定数式の評価中に std::basic_string オブジェクトを作成して使用することが可能です。

しかし、std::basic_string オブジェクトは、動的に割り当てられたストレージが同じ定数式の評価中に解放されなければならないため、一般的に constexpr にはなれません。

(C++20以降)

一般的な文字型のためにいくつかの typedef が提供されています

ヘッダ `<string>` で定義
型	定義
`std::string`	std::basic_string<char>
`std::wstring`	std::basic_string<wchar_t>
`std::u8string` (C++20)	std::basic_string<char8_t>
`std::u16string` (C++11)	std::basic_string<char16_t>
`std::u32string` (C++11)	std::basic_string<char32_t>
`std::pmr::string` (C++17)	std::pmr::basic_string<char>
`std::pmr::wstring` (C++17)	std::pmr::basic_string<wchar_t>
`std::pmr::u8string` (C++20)	std::pmr::basic_string<char8_t>
`std::pmr::u16string` (C++17)	std::pmr::basic_string<char16_t>
`std::pmr::u32string` (C++17)	std::pmr::basic_string<char32_t>

[編集] テンプレートパラメータ

CharT	-	文字型
Traits	-	文字型に対する操作を指定する traits クラス
アロケータ	-	内部ストレージを割り当てるために使用される Allocator 型

[編集] ネストされた型

型定義

traits_type Traits

value_type CharT

allocator_type Allocator[編集]

size_type

`Allocator::size_type`	(C++11まで)
std::allocator_traits<Allocator>::size_type	(C++11以降)

[編集]

difference_type

Allocator::difference_type	(C++11まで)
std::allocator_traits<Allocator>::difference_type	(C++11以降)

[編集]

reference value_type&[編集]

const_reference const value_type&[編集]

pointer

`Allocator::pointer`	(C++11まで)
std::allocator_traits<Allocator>::pointer	(C++11以降)

[編集]

const_pointer

`Allocator::const_pointer`	(C++11まで)
std::allocator_traits<Allocator>::const_pointer	(C++11以降)

[編集]

iterator

`value_type` への LegacyRandomAccessIterator および LegacyContiguousIterator	(C++20まで)
`value_type` への LegacyRandomAccessIterator, `contiguous_iterator`, および ConstexprIterator	(C++20以降)

[編集]

const_iterator

const value_type への LegacyRandomAccessIterator および LegacyContiguousIterator	(C++20まで)
const value_type への LegacyRandomAccessIterator, `contiguous_iterator`, および ConstexprIterator	(C++20以降)

[編集]

reverse_iterator std::reverse_iterator<iterator>[編集]

const_reverse_iterator std::reverse_iterator<const_iterator>[編集]

[編集] データメンバ

constexpr size_type npos [static] 特別な値 size_type(-1)、その正確な意味は文脈に依存します

[編集] メンバ関数

(コンストラクタ)	`basic_string` を構築する (public member function) [編集]
(デストラクタ)	文字列を破棄し、使用されている場合は内部ストレージを解放する (public member function) [編集]
operator=	文字列に値を代入する (public member function) [編集]
代入する	文字列に文字を代入する (public member function) [編集]
assign_range (C++23)	文字列に文字の範囲を代入する (public member function) [編集]
get_allocator	関連付けられたアロケータを返す (public member function) [編集]
要素アクセス
at	境界チェック付きで指定された文字にアクセスする (public member function) [編集]
operator[]	指定された文字にアクセスする (public member function) [編集]
front (DR*)	最初の文字にアクセスする (public member function) [編集]
back (DR*)	最後の文字にアクセスする (public member function) [編集]
data	文字列の最初の文字へのポインタを返す (public member function) [編集]
c_str	文字列の変更不可能な標準C文字配列バージョンを返す (public member function) [編集]
operator basic_string_view (C++17)	文字列全体への変更不可能な `basic_string_view` を返す (public member function) [編集]
イテレータ
begincbegin (C++11)	先頭へのイテレータを返す (public member function) [編集]
endcend (C++11)	末尾へのイテレータを返す (public member function) [編集]
rbegincrbegin (C++11)	先頭への逆イテレータを返す (public member function) [編集]
rendcrend (C++11)	末尾への逆イテレータを返す (public member function) [編集]
容量
empty	文字列が空かどうかをチェックする (public member function) [編集]
sizelength	文字数を返す (public member function) [編集]
max_size	最大文字数を返す (public member function) [編集]
reserve	ストレージを予約する (public member function) [編集]
capacity	現在割り当てられているストレージに保持できる文字数を返す (public member function) [編集]
shrink_to_fit (DR*)	未使用のメモリを解放してメモリ使用量を削減する (public member function) [編集]
変更
clear	内容をクリアする (public member function) [編集]
insert	文字を挿入する (public member function) [編集]
insert_range (C++23)	文字の範囲を挿入する (public member function) [編集]
erase	文字を削除する (public member function) [編集]
push_back	末尾に文字を追加する (public member function) [編集]
pop_back (DR*)	最後の文字を削除する (public member function) [編集]
append	末尾に文字を追加する (public member function) [編集]
append_range (C++23)	末尾に文字の範囲を追加する (public member function) [編集]
operator+=	末尾に文字を追加する (public member function) [編集]
replace	文字列の指定された部分を置換する (public member function) [編集]
replace_with_range (C++23)	文字列の指定された部分を文字の範囲で置換する (public member function) [編集]
copy	文字をコピーする (public member function) [編集]
resize	格納されている文字数を変更する (public member function) [編集]
resize_and_overwrite (C++23)	格納されている文字数を変更し、ユーザー提供の操作を介して不定な内容を上書きする可能性がある (public member function) [編集]
swap	内容を交換する (public member function) [編集]
検索
find	指定された部分文字列が最初に現れる位置を見つける (public member function) [編集]
rfind	部分文字列が最後に現れる位置を見つける (public member function) [編集]
find_first_of	文字が最初に現れる位置を見つける (public member function) [編集]
find_first_not_of	文字が最初に現れない位置を見つける (public member function) [編集]
find_last_of	文字が最後に現れる位置を見つける (public member function) [編集]
find_last_not_of	文字が最後に現れない位置を見つける (public member function) [編集]
操作
compare	2つの文字列を比較する (public member function) [編集]
starts_with (C++20)	文字列が指定された接頭辞で始まるかをチェックする (public member function) [編集]
ends_with (C++20)	文字列が指定された接尾辞で終わるかをチェックする (public member function) [編集]
contains (C++23)	文字列が指定された部分文字列または文字を含むかをチェックする (public member function) [編集]
substr	部分文字列を返す (public member function) [編集]

[編集] 非メンバ関数

operator+	2つの文字列、文字列と char、または文字列と string_view を連結する (function template) [編集]
operator==operator!=operator<operator>operator<=operator>=operator<=> (C++20で削除)(C++20で削除)(C++20で削除)(C++20で削除)(C++20で削除)(C++20)	2つの文字列を辞書順で比較する (function template) [編集]
std::swap(std::basic_string)	std::swap アルゴリズムを特殊化する (function template) [編集]
erase(std::basic_string)erase_if(std::basic_string) (C++20)	特定の基準を満たすすべての要素を削除する (関数テンプレート) [編集]
入出力
operator<<operator>>	文字列に対するストリーム入出力を実行する (function template) [編集]
getline	I/Oストリームから文字列にデータを読み込む (function template) [編集]
数値変換
stoistolstoll (C++11)(C++11)(C++11)	文字列を符号付き整数に変換する (function) [編集]
stoulstoull (C++11)(C++11)	文字列を符号なし整数に変換する (function) [編集]
stofstodstold (C++11)(C++11)(C++11)	文字列を浮動小数点値に変換する (function) [編集]
to_string (C++11)	整数値または浮動小数点値を `string` に変換する (function) [編集]
to_wstring (C++11)	整数値または浮動小数点値を `wstring` に変換する (function) [編集]

[編集] リテラル

インライン名前空間 `std::literals::string_literals` 内で定義
operator""s (C++14)	文字配列リテラルを `basic_string` に変換する (function) [編集]

[編集] ヘルパークラス

std::hash<std::basic_string>

(C++11)

文字列のハッシュサポート
(クラステンプレートの特殊化) [編集]

[編集] 推論ガイド (C++17以降)

[編集] イテレータの無効化

basic_string の要素を参照する参照、ポインタ、イテレータは、std::getline、std::swap、または operator>> のように、非constの basic_string への参照を引数として取る任意の標準ライブラリ関数によって無効化される可能性があります。また、operator[], at, data, front, back, begin, rbegin, end, および rend を除く非constメンバ関数を呼び出すことによっても無効化される可能性があります。

[編集] ノート

C++23まで、std::basic_string の要素を構築または破棄する際にカスタマイズされた construct または destroy を使用することが要求されていましたが、全ての実装はデフォルトのメカニズムのみを使用していました。この要件は、既存の実践に合わせるために P1072R10 によって修正されました。

機能テストマクロ	値	規格	機能
`__cpp_lib_string_udls`	`201304L`	(C++14)	文字列型のためのユーザー定義リテラル
`__cpp_lib_starts_ends_with`	`201711L`	(C++20)	`starts_with`, `ends_with`
`__cpp_lib_constexpr_string`	`201907L`	(C++20)	`std::basic_string` のための Constexpr
`__cpp_lib_char8_t`	`201907L`	(C++20)	`std::u8string`
`__cpp_lib_erase_if`	`202002L`	(C++20)	`erase`、`erase_if`
`__cpp_lib_string_contains`	`202011L`	(C++23)	`contains`
`__cpp_lib_string_resize_and_overwrite`	`202110L`	(C++23)	`resize_and_overwrite`
`__cpp_lib_containers_ranges`	`202202L`	(C++23)	コンテナ互換範囲を受け入れる構築、挿入、置換のためのメンバ関数

[編集] 例

このコードを実行

#include <iostream>
#include <string>
 
int main()
{
    using namespace std::literals;
 
    // Creating a string from const char*
    std::string str1 = "hello";
 
    // Creating a string using string literal
    auto str2 = "world"s;
 
    // Concatenating strings
    std::string str3 = str1 + " " + str2;
 
    // Print out the result
    std::cout << str3 << '\n';
 
    std::string::size_type pos = str3.find(" ");
    str1 = str3.substr(pos + 1); // the part after the space
    str2 = str3.substr(0, pos);  // the part till the space
 
    std::cout << str1 << ' ' << str2 << '\n';
 
    // Accessing an element using subscript operator[]
    std::cout << str1[0] << '\n';
    str1[0] = 'W';
    std::cout << str1 << '\n';
}

出力

hello world
world hello
w
World

[編集] 欠陥報告

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

DR	適用対象	公開された動作	正しい動作
LWG 530	C++98	`basic_string` の要素のストレージの連続性 LWG259 によって誤って必須ではなくなった	再び必須になった
LWG 2861	C++98	`value_type` は `Traits::char_type` であった	`CharT` に変更された
LWG 2994 (P1148R0)	C++98	`Traits::char_type`^[1] のいずれかがおよび `Allocator::char_type` が `CharT` と異なる場合、振る舞いは未定義である	プログラムは不適格となるこの場合不適格となる

↑ Traits::char_type のケースは P1148R0 で修正されました。

[編集] 関連項目

basic_string_view

(C++17)

読み取り専用の文字列ビュー
(class template) [編集]

[編集] 外部リンク

C++ string handling

[1] Traits::char_type のケースは P1148R0 で修正されました。

[1]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作

std::basic_string

目次

[編集] テンプレートパラメータ

[編集] ネストされた型

[編集] データメンバ

[編集] メンバ関数

要素アクセス

イテレータ

容量

変更

検索

操作

[編集] 非メンバ関数

入出力

数値変換

[編集] リテラル

[編集] ヘルパークラス

[編集] 推論ガイド (C++17以降)

[編集] イテレータの無効化

[編集] ノート

[編集] 例

[編集] 欠陥報告

[編集] 関連項目

[編集] 外部リンク

ナビゲーション

ツールボックス