# std::basic_stringbuf

From cppreference.com
< cpp‎ | io

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 overflow(), an additional high-watermark pointer may be stored to track the last initialized character | (since C++11)

Two specializations for common character types are also defined:

Defined in header `<sstream>`
Type | Definition
`stringbuf` | basic_stringbuf<char>
`wstringbuf` | 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 (since C++11)

### Member functions

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

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

(destructor) [virtual] | destructs the basic_streambuf object (virtual public member function of `std::basic_streambuf<CharT,Traits>`)
##### Locales
pubimbue | invokes imbue() (public member function of `std::basic_streambuf<CharT,Traits>`)
getloc | obtains a copy of the associated locale (public member function of `std::basic_streambuf<CharT,Traits>`)
##### Positioning
pubsetbuf | invokes setbuf() (public member function of `std::basic_streambuf<CharT,Traits>`)
pubseekoff | invokes seekoff() (public member function of `std::basic_streambuf<CharT,Traits>`)
pubseekpos | invokes seekpos() (public member function of `std::basic_streambuf<CharT,Traits>`)
pubsync | invokes sync() (public member function of `std::basic_streambuf<CharT,Traits>`)
##### Get area
in_avail | obtains the number of characters immediately available in the get area (public member function of `std::basic_streambuf<CharT,Traits>`)
snextc | advances the input sequence, then reads one character without advancing again (public member function of `std::basic_streambuf<CharT,Traits>`)
sbumpc | reads one character from the input sequence and advances the sequence (public member function of `std::basic_streambuf<CharT,Traits>`)
stossc (deprecated in C++98)(removed in C++17) | advances the input sequence as if by calling sbumpc() and discarding the result (public member function)
sgetc | reads one character from the input sequence without advancing the sequence (public member function of `std::basic_streambuf<CharT,Traits>`)
sgetn | invokes xsgetn() (public member function of `std::basic_streambuf<CharT,Traits>`)
##### Put area
sputc | writes one character to the put area and advances the next pointer (public member function of `std::basic_streambuf<CharT,Traits>`)
sputn | invokes xsputn() (public member function of `std::basic_streambuf<CharT,Traits>`)
##### Putback
sputbackc | puts one character back in the input sequence (public member function of `std::basic_streambuf<CharT,Traits>`)
sungetc | moves the next pointer in the input sequence back by one (public member function of `std::basic_streambuf<CharT,Traits>`)

### Protected member functions

(constructor) | constructs a basic_streambuf object (protected member function)
operator= (C++11) | replaces a basic_streambuf object (protected member function)
swap (C++11) | swaps two basic_streambuf objects (protected member function)
##### Locales
imbue [virtual] | changes the associated locale (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
##### Positioning
setbuf [virtual] | replaces the buffer with user-defined array, if permitted (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
seekoff [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>`)
seekpos [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>`)
sync [virtual] | synchronizes the buffers with the associated character sequence (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
##### Get area
showmanyc [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>`)
underflow [virtual] | reads characters from the associated input sequence to the get area (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
uflow [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>`)
xsgetn [virtual] | reads multiple characters from the input sequence (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
eback gptr egptr | returns a pointer to the beginning, current character and the end of the get area (protected member function)
gbump | advances the next pointer in the input sequence (protected member function)
setg | repositions the beginning, next, and end pointers of the input sequence (protected member function)
##### Put area
xsputn [virtual] | writes multiple characters to the output sequence (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
overflow [virtual] | writes characters to the associated output sequence from the put area (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
pbase pptr epptr | returns a pointer to the beginning, current character and the end of the put area (protected member function)
pbump | advances the next pointer of the output sequence (protected member function)
setp | repositions the beginning, next, and end pointers of the output sequence (protected member function)
##### Putback
pbackfail [virtual] | puts a character back into the input sequence, possibly modifying the input sequence (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)

Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/io/basic_stringbuf&oldid=64376"