Difference between revisions of "cpp/io/basic stringbuf"
From cppreference.com
m (c -> c/core.) |
(Applied {{cpp/basic char typedefs}}.) |
||
| Line 16: | Line 16: | ||
{{rrev|since=c++11|if over-allocation strategy is used by {{lc|overflow()}}, an additional high-watermark pointer may be stored to track the last initialized character.}} | {{rrev|since=c++11|if over-allocation strategy is used by {{lc|overflow()}}, an additional high-watermark pointer may be stored to track the last initialized character.}} | ||
| − | + | {{cpp/basic char typedefs|stringbuf|sstream}} | |
| − | {{ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
===Member types=== | ===Member types=== | ||
Revision as of 17:55, 14 February 2023
| Defined in header <sstream>
|
||
| template< class CharT, |
||
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 overflow(), an additional high-watermark pointer may be stored to track the last initialized character. |
(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> |
Contents |
Member types
| 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
|
Member functions
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) |
Non-member functions
| specializes the std::swap algorithm (function template) |
Inherited from std::basic_streambuf
Member types
| 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
|
Member functions
| [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>)
| |
Protected member functions
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>)
|
