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

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Строки

Строки с завершающим нулём

Однобайтовые строки

Многобайтовые строки

Широкие строки

Классы

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 (DR*) basic_string::endbasic_string::cend (DR*) basic_string::rbeginbasic_string::crbegin (DR*) basic_string::rendbasic_string::crend (DR*) Ёмкость 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::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::compare basic_string::replace basic_string::replace_with_range (C++23) basic_string::substr basic_string::copy basic_string::resize basic_string::resize_and_overwrite (C++23)   basic_string::swap

Поиск basic_string::starts_with (C++20)   basic_string::ends_with (C++20) basic_string::contains (C++23) 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::npos Правила вывода (C++17) Функции, не являющиеся элементами operator+ swap(std::basic_string) operator""s (C++14) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) Ввод/Вывод 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) Вспомогательные классы hash<std::string>hash<std::wstring>hash<std::u32string>hash<std::u16string>hash<std::u8string> (C++11)  (C++11)(C++11)(C++11)(C++20) hash<std::pmr::string>hash<std::pmr::wstring>hash<std::pmr::u32string>hash<std::pmr::u16string>hash<std::pmr::u8string> (C++17)(C++17)(C++17)(C++17)(C++20)

 

	(1)
basic_string substr( size_type pos = 0, size_type count = npos ) const;			(до C++20)
constexpr basic_string     substr( size_type pos = 0, size_type count = npos ) const;			(начиная с C++20) (до C++23)
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()).

Исключения

std::out_of_range, если pos > size().

Если по какой-либо причине генерируется исключение, эти функции не имеют эффекта (строгая гарантия безопасности исключений).

Сложность

Линейная по count.

Примечание

Аллокатор возвращаемой строки создаётся по умолчанию: новый аллокатор может не быть копией get_allocator().

Пример

Запустить этот код

#include <iostream>
#include <string>
 
int main()
{
    std::string a = "0123456789abcdefghij";
 
    // count равно npos, возвращается [pos, size())
    std::string sub1 = a.substr(10);
    std::cout << sub1 << '\n';
 
    // и pos, и pos + count находятся в пределах границ, возвращается [pos, pos + count)
    std::string sub2 = a.substr(5, 3);
    std::cout << sub2 << '\n';
 
    // pos находится в пределах границ, pos + count нет, возвращается [pos, size())
    std::string sub4 = a.substr(a.size() - 3, 50);
    // это фактически эквивалентно
    // std::string sub4 = a.substr(17, 3);
    // поскольку a.size() == 20, pos == a.size() - 3 == 17, и a.size() - pos == 3
 
    std::cout << sub4 << '\n';
 
    try
    {
        // pos находится за пределами границ, генерируется исключение
        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++:

Номер	Применён	Поведение в стандарте	Корректное поведение
LWG 847	C++98	не было гарантии безопасности исключений	добавлена надёжная гарантия безопасности исключений

Смотрите также

copy	копирует символы (public функция-элемент)
sizelength	возвращает количество символов (public функция-элемент)
find	находит первое вхождение заданной подстроки (public функция-элемент)
npos [static]	специальное значение. Точное значение зависит от контекста (public static константа-элемент)
substr (C++17)	возвращает подстроку (public функция-элемент std::basic_string_view<CharT,Traits>)