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

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros(C++20)

Language support library

Concepts library(C++20)

Diagnostics library

Memory management library

Metaprogramming library(C++11)

General utilities library

Containers library

Iterators library

Ranges library(C++20)

Algorithms library

Strings library

Text processing library

Numerics library

Date and time library

Input/output library

Filesystem library(C++17)

Concurrency support library(C++11)

Execution control library(C++26)

Technical specifications

Symbols index

External libraries

 

Strings library

Classes

basic_string

basic_string_view (C++17)

char_traits

 

std::basic_string

Member functions basic_string::basic_string basic_string::~basic_string basic_string::operator= basic_string::assign basic_string::assign_range (C++23)   basic_string::get_allocator Element access 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) Iterators 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) Search 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

Modifiers 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 Capacity basic_string::empty basic_string::sizebasic_string::length basic_string::max_size basic_string::reserve basic_string::capacity basic_string::shrink_to_fit (DR*) Operations basic_string::compare basic_string::starts_with (C++20) basic_string::ends_with (C++20) basic_string::contains (C++23) basic_string::substr

Constants basic_string::npos Non-member functions operator+ swap(std::basic_string) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) I/O operator<<operator>> getline Comparison operator==operator!=operator<operator>operator<=operator>=operator<=> (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20) Numeric conversions 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) Literals operator""s (C++14) Helper classes hash<std::basic_string> (C++11) Deduction guides(C++17)

 

	(1)
basic_string substr( size_type pos =0, size_type count = npos )const;			(until C++23) (constexpr since C++20)
constexpr basic_string     substr( size_type pos =0, size_type count = npos )const&;			(since C++23)
constexpr basic_string substr( size_type pos =0, size_type count = npos )&&;		(2)	(since C++23)

Returns a substring [pos, pos + count). If the requested substring extends past the end of the string, i.e. the count is greater than size()- pos (e.g. if count == npos), the returned substring is [pos, size()).

1) Equivalent to return basic_string(*this, pos, count);.

2) Equivalent to return basic_string(std::move(*this), pos, count);.

Parameters

pos	-	position of the first character to include
count	-	length of the substring

Return value

String containing the substring [pos, pos + count) or [pos, size()).

Exceptions

std::out_of_range if pos > size().

If an exception is thrown for any reason, these functions have no effect (strong exception safety guarantee).

Complexity

Linear in count.

Notes

The allocator of the returned string is default-constructed: the new allocator might not be a copy of get_allocator().

Example

Run this code

#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, throwsstd::string sub5 = a.substr(a.size()+3, 50);std::cout<< sub5 <<'\n';}catch(conststd::out_of_range& ex){std::cout<< ex.what()<<'\n';}}

Possible output:

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

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 847	C++98	there was no exception safety guarantee	added strong exception safety guarantee

See also

copy	copies characters (public member function)
sizelength	returns the number of characters (public member function)
find	finds the first occurrence of the given substring (public member function)
constexpr size_typenpos[static]	the special value size_type(-1), its exact meaning depends on the context
substr	returns a substring (public member function of std::basic_string_view<CharT,Traits>)