std::strstreambuf

From Cppreference

C++ Standard Library
Language Utilities library Strings library Containers library Algorithms library Iterators library Numerics library Input/output library Localizations library Regular expressions library (C++11) Atomic operations library (C++11) Thread support library (C++11)
Input/output library
I/O manipulators C-style I/O Buffers basic_streambuf basic_filebuf basic_stringbuf strstreambuf (deprecated) Streams Abstractions ios_base basic_ios basic_istream basic_ostream basic_iostream File I/O basic_ifstream basic_ofstream basic_fstream String I/O basic_istringstream basic_ostringstream basic_stringstream Array I/O istrstream (deprecated) ostrstream (deprecated) Types streamoff streampos fpos Error category interface iostream_category (C++11) io_errc (C++11)
std::strstreambuf
Public member functions strstreambuf::strstreambuf strstreambuf::~strstreambuf strstreambuf::freeze strstreambuf::str strstreambuf::pcount Protected member functions strstreambuf::underflow strstreambuf::pbackfail strstreambuf::overflow strstreambuf::setbuf strstreambuf::seekoff strstreambuf::seekpos

Defined in header <strstream>
class strstreambuf : public std::basic_streambuf<char>		(deprecated)

std::strstreambuf is a std::basic_streambuf whose associated character sequence is a character array, which may be constant (e.g. a string literal), modifyable but not dynamic (e.g. a stack-allocated array), or dynamic, in which case the std::strstreambuf may be allowed to reallocate the array as necessary to accomodate output (e.g. by calling delete[] and new[] or user-provided functions).

Typical implementation of a std::strstreambuf holds four private data members:

1) buffer state, a bitmask type which can represent any combination of the four values "allocated" (destructor will deallocate), "constant" (output not allowed), "dynamic" (output may reallocate), or "frozen" (output, deallocation, reallocation are not allowed)

2) allocated buffer size

3) pointer to user-provided allocation function

4) pointer to user-provided deallocation function.

Contents 1 Notes 2 Member functions 3 Public member functions 4 Protected member functions 5 Inherited from std::basic_streambuf 5.1 Member types 5.2 Member types 5.3 Member functions 5.3.1 Locales 5.3.2 Positioning 5.3.3 Get area 5.3.4 Put area 5.3.5 Putback 5.4 Protected member functions 5.4.1 Locales 5.4.2 Positioning 5.4.3 Get area 5.4.4 Put area 5.4.5 Putback

[edit] Notes

After any call to str(), a call to freeze(false) is required to allow the strstreambuf destructor to deallocate the buffer when necessary.

[edit] Member functions

Public member functions
(constructor)	constructs a strstreambuf object (public member function)
(destructor) [virtual]	destructs a strstreambuf object, optionally deallocating the character array (virtual public member function)
freeze	sets/clears the frozen state of the buffer (public member function)
str	marks the buffer frozen and returns the beginning pointer of the input sequence (public member function)
pcount	returns the next pointer minus the beginning pointer in the output sequence: the number of characters written (public member function)
Protected member functions
underflow [virtual]	reads a character from the input sequence without advancing the next pointer (virtual protected member function)
pbackfail [virtual]	puts back a character into the input sequence (virtual protected member function)
overflow [virtual]	appends a character to the output sequence, may reallocate or initially allocate the buffer if dynamic and not frozen (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)