std::basic_stringbuf

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 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

In addition, a typical implementation holds a data member of type std::ios_base::openmode

If over-allocation strategy is used by overflow()

(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 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

Exposition-only members

buf	the std::basic_string <CharT, Traits, Allocator> used as the underlying buffer (exposition-only member object*
mode	the std::ios_base::openmode of the associated stream (exposition-only member object*
init_buf_ptrs	initializes the input and output sequences (exposition-only member function*

Public member functions

(constructor)	constructs a basic_stringbuf object (public member function)
operator= (C++11)	assigns a basic_stringbuf object (public member function)
swap (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)
str	replaces or obtains a copy of the associated character string (public member function)
get_allocator (C++20)	obtains a copy of the allocator associated with the internal sequence container (public member function)
view (C++20)	obtains a view over the underlying character sequence (public member function)

Protected member functions

underflow [virtual]	returns the next character available in the input sequence (virtual protected member function)
pbackfail [virtual]	puts a character back into the input sequence (virtual protected member function)
overflow [virtual]	appends a character to the output sequence (virtual protected member function)
setbuf [virtual]	attempts to replace the controlled character sequence with an array (virtual protected member function)
seekoff [virtual]	repositions the next pointer in the input sequence, output sequence, or both, using relative addressing (virtual protected member function)
seekpos [virtual]	repositions the next pointer in the input sequence, output sequence, or both using absolute addressing (virtual protected member function)

Non-member functions

std::swap(std::basic_stringbuf) (C++11)

specializes the std::swap algorithm (function template)