std::out_of_range
(C++17)<stdexcept>
Defines a type of object to be thrown as exception. It reports errors that are consequence of attempt to access elements out of defined range.
It may be thrown by the member functions of std::bitset and std::basic_string , by std::stoi and std::stod families of functions, and by the bounds-checked member access functions (e.g. std::vector::at and std::map::at ).
std::out_of_range are constexpr: it is possible to create and use std::out_of_range objects in the evaluation of a constant expression.However, std::out_of_range objects generally cannot be constexpr, because any dynamically allocated storage must be released in the same evaluation of constant expression.
Inheritance diagram
Contents
[edit] Member functions
out_of_range object with the given message (public member function)
out_of_range object (public member function)
std::out_of_range::out_of_range
(constexpr since C++26)
std::out_of_range then std::strcmp (what(), other.what()) == 0. No exception can be thrown from the copy constructor.Parameters
Exceptions
Notes
Because copying std::out_of_range is not permitted to throw exceptions, this message is typically stored internally as a separately-allocated reference-counted string. This is also why there is no constructor taking std::string&&: it would have to copy the content anyway.
Before the resolution of LWG issue 254, the non-copy constructor can only accept std::string . It makes dynamic allocation mandatory in order to construct a std::string object.
After the resolution of LWG issue 471, a derived standard exception class must have a publicly accessible copy constructor. It can be implicitly defined as long as the explanatory strings obtained by what() are the same for the original object and the copied object.
std::out_of_range::operator=
(constexpr since C++26)
Assigns the contents with those of other. If *this and other both have dynamic type std::out_of_range then std::strcmp (what(), other.what()) == 0 after assignment. No exception can be thrown from the copy assignment operator.
Parameters
Return value
*this
Notes
After the resolution of LWG issue 471, a derived standard exception class must have a publicly accessible copy assignment operator. It can be implicitly defined as long as the explanatory strings obtained by what() are the same for the original object and the copied object.
Inherited from std::logic_error
Inherited from std::exception
Member functions
[edit] Notes
The standard error condition std::errc::result_out_of_range typically indicates the condition where the result, rather than the input, is out of range, and is more closely related to std::range_error and ERANGE .
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_constexpr_exceptions |
202502L |
(C++26) | constexpr exception types |
[edit] 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 254 | C++98 | the constructor accepting const char* was missing | added |
| LWG 471 | C++98 | the explanatory strings of std::out_of_range'scopies were implementation-defined |
they are the same as that of the original std::out_of_range object
|
[edit] See also
(public member function of
std::basic_string<CharT,Traits,Allocator>) [edit]
(public member function of
std::basic_string_view<CharT,Traits>) [edit]
(public member function of
std::deque<T,Allocator>) [edit]
(public member function of
std::map<Key,T,Compare,Allocator>) [edit]
(public member function of
std::unordered_map<Key,T,Hash,KeyEqual,Allocator>) [edit]
(public member function of
std::vector<T,Allocator>) [edit]