Defined in header <sstream> | ||
|---|---|---|
template<
class CharT,
class Traits = std::char_traits<CharT>,
class Allocator = std::allocator<CharT>
> class basic_stringbuf : public std::basic_streambuf<CharT, Traits>
|
std::basic_stringbuf is a std::basic_streambuf whose associated character sequence is a memory-resident sequence of arbitrary characters, which can be initialized from or made available as an instance of std::basic_string.
Typical implementations of std::basic_stringbuf hold an object of type std::basic_string or equivalent resizeable sequence container directly as a data member and use it as both the controlled character sequence (the array where the six pointers of std::basic_streambuf are pointing to) and as the associated character sequence (the source of characters for all input operations and the target for the output).
In addition, a typical implementation holds a data member of type std::ios_base::openmode to indicate the status of the stream (input-only, output-only, input/output, at-end, etc).
| if over-allocation strategy is used by | (since C++11) |
Several typedefs for common character types are provided:
Defined in header <sstream> |
|
|---|---|
| Type | Definition |
std::stringbuf | std::basic_stringbuf<char> |
std::wstringbuf | std::basic_stringbuf<wchar_t> |
| Member type | Definition |
|---|---|
char_type | CharT |
traits_type | Traits; the program is ill-formed if Traits::char_type is not CharT. |
int_type | Traits::int_type |
pos_type | Traits::pos_type |
off_type | Traits::off_type |
allocator_type | Allocator |
Public member functions |
|
constructs a basic_stringbuf object (public member function) |
|
|
(C++11) | assigns a basic_stringbuf object (public member function) |
|
(C++11) | swaps two basic_stringbuf objects (public member function) |
| (destructor)
[virtual] (implicitly declared) | destructs a basic_stringbuf object and the string it holds (virtual public member function) |
| replaces or obtains a copy of the associated character string (public member function) |
|
|
(C++20) | obtains a copy of the allocator associated with the internal sequence container (public member function) |
|
(C++20) | obtains a view over the underlying character sequence (public member function) |
Protected member functions |
|
|
[virtual] | returns the next character available in the input sequence (virtual protected member function) |
|
[virtual] | puts a character back into the input sequence (virtual protected member function) |
|
[virtual] | appends a character to the output sequence (virtual protected member function) |
|
[virtual] | attempts to replace the controlled character sequence with an array (virtual protected member function) |
|
[virtual] | repositions the next pointer in the input sequence, output sequence, or both, using relative addressing (virtual protected member function) |
|
[virtual] | repositions the next pointer in the input sequence, output sequence, or both using absolute addressing (virtual protected member function) |
|
(C++11) | specializes the std::swap algorithm (function template) |
| Member type | Definition |
|---|---|
char_type | CharT |
traits_type | Traits; the program is ill-formed if Traits::char_type is not CharT. |
int_type | Traits::int_type |
pos_type | Traits::pos_type |
off_type | Traits::off_type |
|
[virtual] | destructs the basic_streambuf object (virtual public member function of std::basic_streambuf<CharT,Traits>) |
Locales |
|
invokes imbue() (public member function of std::basic_streambuf<CharT,Traits>) |
|
| obtains a copy of the associated locale (public member function of std::basic_streambuf<CharT,Traits>) |
|
Positioning |
|
invokes setbuf() (public member function of std::basic_streambuf<CharT,Traits>) |
|
invokes seekoff() (public member function of std::basic_streambuf<CharT,Traits>) |
|
invokes seekpos() (public member function of std::basic_streambuf<CharT,Traits>) |
|
invokes sync() (public member function of std::basic_streambuf<CharT,Traits>) |
|
Get area |
|
| obtains the number of characters immediately available in the get area (public member function of std::basic_streambuf<CharT,Traits>) |
|
| advances the input sequence, then reads one character without advancing again (public member function of std::basic_streambuf<CharT,Traits>) |
|
|
(removed in C++17) | reads one character from the input sequence and advances the sequence (public member function of std::basic_streambuf<CharT,Traits>) |
| reads one character from the input sequence without advancing the sequence (public member function of std::basic_streambuf<CharT,Traits>) |
|
invokes xsgetn() (public member function of std::basic_streambuf<CharT,Traits>) |
|
Put area |
|
| writes one character to the put area and advances the next pointer (public member function of std::basic_streambuf<CharT,Traits>) |
|
invokes xsputn() (public member function of std::basic_streambuf<CharT,Traits>) |
|
Putback |
|
| puts one character back in the input sequence (public member function of std::basic_streambuf<CharT,Traits>) |
|
| moves the next pointer in the input sequence back by one (public member function of std::basic_streambuf<CharT,Traits>) |
|
constructs a basic_streambuf object (protected member function) |
|
|
(C++11) | replaces a basic_streambuf object (protected member function) |
|
(C++11) | swaps two basic_streambuf objects (protected member function) |
Locales |
|
|
[virtual] | changes the associated locale (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
Positioning |
|
|
[virtual] | replaces the buffer with user-defined array, if permitted (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | repositions the next pointer in the input sequence, output sequence, or both, using relative addressing (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | repositions the next pointer in the input sequence, output sequence, or both using absolute addressing (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | synchronizes the buffers with the associated character sequence (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
Get area |
|
|
[virtual] | obtains the number of characters available for input in the associated input sequence, if known (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | reads characters from the associated input sequence to the get area (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | reads characters from the associated input sequence to the get area and advances the next pointer (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | reads multiple characters from the input sequence (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
| returns a pointer to the beginning, current character and the end of the get area (protected member function) |
|
| advances the next pointer in the input sequence (protected member function) |
|
| repositions the beginning, next, and end pointers of the input sequence (protected member function) |
|
Put area |
|
|
[virtual] | writes multiple characters to the output sequence (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
|
[virtual] | writes characters to the associated output sequence from the put area (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
| returns a pointer to the beginning, current character and the end of the put area (protected member function) |
|
| advances the next pointer of the output sequence (protected member function) |
|
| repositions the beginning, next, and end pointers of the output sequence (protected member function) |
|
Putback |
|
|
[virtual] | puts a character back into the input sequence, possibly modifying the input sequence (virtual protected member function of std::basic_streambuf<CharT,Traits>) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/io/basic_stringbuf