C++

Reference

<sstream>

basic_stringbuf

class template
<sstream>

std::basic_stringbuf

template < class charT,                           // basic_stringbuf::char_type           class traits = char_traits<charT>,     // basic_stringbuf::traits_type           class Alloc = allocator<charT>         // basic_stringbuf::allocator_type           > class basic_stringbuf;
String stream buffer

Stream buffer to read from and write to basic_string objects.

Objects of this class maintain internally a sequence of characters that they use as their associated input sequence and/or associated output sequence. The internal sequence can be initialized from a basic_string object, or copied to one, using member str.

Access to the internal sequence of characters is given to streams by means of the interface offered by the virtual members inherited from basic_streambuf that are overriden in this class:

Template parameters

charT
Character type used by both the stream buffer and the basic_string objects it accepts or generates.
This shall be a non-array POD type.
Aliased as member type basic_stringbuf::char_type.
traits
Character traits class that defines essential properties of the characters used by stream and string objects (see char_traits).
traits::char_type shall be the same as charT.
Aliased as member type basic_stringbuf::traits_type.
Alloc
Type of the allocator object used to define the storage allocation model for the basic_string objects.
By default, the allocator class template is used, which defines the simplest memory allocation model and is value-independent.
Aliased as member type basic_stringbuf::allocator_type.

Template instantiations

stringbuf
String stream buffer (class)
wstringbuf
String stream buffer (wide) (class)
These instantiations are declared in <sstream>.

Member types

member typedefinitionnotes
char_typeThe first template parameter (charT)
traits_typeThe second template parameter (traits)defaults to: char_traits<charT>
allocator_typeThe third template parameter (Alloc)defaults to: allocator<charT>
int_typetraits_type::int_type
pos_typetraits_type::pos_typegenerally, the same as streampos
off_typetraits_type::off_typegenerally, the same as streamoff

Public member functions

(constructor)
Construct object (public member function)
str
Get/set content (public member function)

Public member functions inherited from basic_streambuf

Locales:
pubimbue
Imbue locale (public member function)
getloc
Get current locale (public member function)
Buffer management and positioning:
pubsetbuf
Set buffer array (public member function)
pubseekoff
Set internal position pointer to relative position (public member function)
pubseekpos
Set internal position pointer to absolute position (public member function)
pubsync
Synchronize stream buffer (public member function)
Input functions (get):
in_avail
Get number of character available to read (public member function)
snextc
Advance to next position and get character (public member function)
sbumpc
Get current character and advance to next position (public member function)
sgetc
Get current character (public member function)
sgetn
Get sequence of characters (public member function)
sputbackc
Put character back (public member function)
sungetc
Decrease current position (public member function)
Output functions (put):
sputc
Put character and advance to next position (public member function)
sputn
Put sequence of characters (public member function)

Protected virtual function overrides

setbuf
Set buffer (protected virtual member function)
seekoff
Set position pointer to relative position (protected virtual member function)
seekpos
Set position pointer to absolute position (protected virtual member function)
underflow
Get character (protected virtual member function)
pbackfail
Put character back (protected virtual member function)
overflow
Put character (protected virtual member function)

The class also inherits other protected members that are non-virtual or not overridden. See base class basic_streambuf for more details.