std::basic_stringbuf
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Input/output library
Print functions (C++23)
Buffers
basic_stringbuf
(C++23)
(C++98/26*)
(C++20)
Streams
Abstractions
File I/O
String I/O
Array I/O
(C++23)
(C++23)
(C++23)
(C++98/26*)
(C++98/26*)
(C++98/26*)
Synchronized Output
(C++20)
Types
Error category interface
(C++11)
(C++11)
std::basic_stringbuf
Public member functions
(C++11)
(C++11)
(C++20)
(C++20)
Protected member functions
Non-member functions
(C++11)
Exposition-only member functions
Defined in header
<sstream>
template<
class CharT,
class Traits = std::char_traits <CharT>,
class Allocator = std::allocator <CharT>
> class basic_stringbuf
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 resizable 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 I/O mode of the associated 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
[edit] Member types
Member type
Definition
[edit] Exposition-only members
buf
the std::basic_string <CharT, Traits, Allocator> used as the underlying buffer(exposition-only member object*)
[edit] Public member functions
(destructor)
[virtual] (implicitly declared)
basic_stringbuf object and the string it holds (virtual public member function) [edit]
(C++20)
(public member function) [edit]
[edit] Protected member functions
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[edit] Non-member functions
Inherited from std::basic_streambuf
Member types
Member type
Definition
Member functions
[virtual]
basic_streambuf object (virtual public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Locales
changes the associated locale and invokes imbue()
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
obtains a copy of the associated locale
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Positioning
Get area
obtains the number of characters immediately available in the get area
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
advances the input sequence, then reads one character without advancing again
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
(removed in C++17)
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
reads one character from the input sequence without advancing the sequence
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Put area
writes one character to the put area and advances the next pointer
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Putback
puts one character back in the input sequence
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
moves the next pointer in the input sequence back by one
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Protected member functions
Locales
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
Positioning
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
Get area
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
returns a pointer to the beginning, current character and the end of the get area
(protected member function) [edit]
(protected member function) [edit]
repositions the beginning, next, and end pointers of the input sequence
(protected member function) [edit]
(protected member function) [edit]
Put area
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
returns a pointer to the beginning, current character and the end of the put area
(protected member function) [edit]
(protected member function) [edit]
repositions the beginning, next, and end pointers of the output sequence
(protected member function) [edit]
(protected member function) [edit]