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

 

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)

 

	(1)
basic_string substr( size_type pos = 0, size_type count = npos ) const;			(C++23まで) (C++20 以降 constexpr)
constexpr basic_string     substr( size_type pos = 0, size_type count = npos ) const&;			(C++23から)
constexpr basic_string substr( size_type pos = 0, size_type count = npos ) &&;		(2)	(C++23から)

部分文字列 [pos, pos + count) を返します。要求された部分文字列が文字列の末尾を超えて拡張する場合、つまり count が size() - pos より大きい場合（例えば count == npos の場合）、返される部分文字列は [pos, size()) となります。

1) return basic_string(*this, pos, count); と等価です。

2) return basic_string(std::move(*this), pos, count); と等価です。

パラメーター

pos	-	含める最初の文字の位置
count	-	部分文字列の長さ

戻り値

部分文字列 [pos, pos + count) または [pos, size()) を含む文字列。

例外

pos > size() の場合、std::out_of_range。

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

複雑性

count に対して線形。

注釈

返される文字列のアロケーターはデフォルト構築されます。新しいアロケーターは get_allocator() のコピーではない可能性があります。

例

このコードを実行

#include <iostream>
#include <string>
 
int main()
{
    std::string a = "0123456789abcdefghij";
 
    // count is npos, returns [pos, size())
    std::string sub1 = a.substr(10);
    std::cout << sub1 << '\n';
 
    // both pos and pos + count are within bounds, returns [pos, pos + count)
    std::string sub2 = a.substr(5, 3);
    std::cout << sub2 << '\n';
 
    // pos is within bounds, pos + count is not, returns [pos, size())
    std::string sub4 = a.substr(a.size() - 3, 50);
    // this is effectively equivalent to
    // std::string sub4 = a.substr(17, 3);
    // since a.size() == 20, pos == a.size() - 3 == 17, and a.size() - pos == 3
 
    std::cout << sub4 << '\n';
 
    try
    {
        // pos is out of bounds, throws
        std::string sub5 = a.substr(a.size() + 3, 50);
        std::cout << sub5 << '\n';
    }
    catch (const std::out_of_range& ex)
    {
        std::cout << ex.what() << '\n';
    }
}

実行結果の例

abcdefghij
567
hij
basic_string::substr: __pos (which is 23) > this->size() (which is 20)

欠陥レポート

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

DR	適用対象	公開された動作	正しい動作
LWG 847	C++98	例外安全性保証がなかった	強力な例外安全性保証を追加

関連項目

copy	文字をコピーする (public member function)
sizelength	文字数を返す (public member function)
find	指定された部分文字列が最初に現れる位置を見つける (public member function)
constexpr size_type npos [static]	特殊な値 size_type(-1)。その正確な意味はコンテキストによって異なります。
substr	部分文字列を返す (std::basic_string_view<CharT,Traits> の public メンバー関数)