std::basic_stringbuf

From Cppreference

< cpp | io
Jump to: navigation, search
C++ Standard Library
Input/output library
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 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, or input/output).

Two specializations for common character types are also defined:

Defined in header <sstream>
Type Definition
stringbuf basic_stringbuf<char>
wstringbuf basic_stringbuf<wchar_t>

Contents

[edit] Member types

Member type Definition
char_type CharT
traits_type Traits
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type
allocator_type Allocator (since C++11)

[edit] Member functions

Public member functions

constructs a basic_stringbuf object
(public member function)
(C++11)
 assigns a basic_stringbuf object
(public member function)
(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)
replaces or obtains a copy of the associated character string
(public member function)

Protected member functions

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

[edit] Non-member functions

(C++11)
 specializes the std::swap algorithm
(function template)

Inherited from std::basic_streambuf

Member types

Member types

Member type Definition
char_type CharT
traits_type Traits
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type

Member functions

[virtual]
 destructs the basic_streambuf object
(virtual public member function)
Locales
invokes imbue()
(public member function)
obtains a copy of the associated locale
(public member function)
Positioning
invokes setbuf()
(public member function)
invokes seekoff()
(public member function)
invokes seekpos()
(public member function)
invokes sync()
(public member function)
Get area
obtains the number of characters immediately available in the get area
(public member function)
advances the input sequence, then reads one character without advancing again
(public member function)
reads one character from the input sequence and advances the sequence
(public member function)
reads one character from the input sequence without advancing the sequence
(public member function)
invokes xsgetn()
(public member function)
Put area
writes one character to the put area and advances the next pointer
(public member function)
invokes xsputn()
(public member function)
Putback
puts one character back in the input sequence
(public member function)
moves the next pointer in the input sequence back by one
(public member function)

Protected member functions

(C++11)
 replaces a basic_streambuf object
(protected member function)
(C++11)
 swaps two basic_streambuf objects
(protected member function)
Locales
[virtual]
 changes the associated locale
(virtual protected member function)
Positioning
[virtual]
 replaces the buffer with user-defined array, if permitted
(virtual protected member function)
[virtual]
 repositions the next pointer in the input sequence, output sequence, or both, using relative addressing
(virtual protected member function)
[virtual]
 repositions the next pointer in the input sequence, output sequence, or both using absolute addressing
(virtual protected member function)
[virtual]
 synchronizes the buffers with the associated character sequence
(virtual protected member function)
Get area
[virtual]
 obtains the number of characters available for input in the associated input sequence, if known
(virtual protected member function)
[virtual]
 reads characters from the associated input sequence to the get area
(virtual protected member function)
[virtual]
 reads characters from the associated input sequence to the get area and advances the next pointer
(virtual protected member function)
[virtual]
 reads multiple characters from the input sequence
(virtual protected member function)
returns the beginning pointer of the input sequence
(protected member function)
returns the next pointer of the input sequence
(protected member function)
returns the end pointer of the input sequence
(protected member function)
advances the next pointer in the input sequence
(protected member function)
repositions the beginning, next, and end pointers of the input sequence
(protected member function)
Put area
[virtual]
 writes multiple characters to the output sequence
(virtual protected member function)
[virtual]
 writes characters to the associated output sequence from the put area
(virtual protected member function)
returns the beginning pointer of the output sequence
(protected member function)
returns the next pointer of the output sequence
(protected member function)
returns the end pointer of the output sequence
(protected member function)
advances the next pointer of the output sequence
(protected member function)
repositions the beginning, next, and end pointers of the output sequence
(protected member function)
Putback
[virtual]
 puts a character back into the input sequence, possibly modifying the input sequence
(virtual protected member function)
Retrieved from "http://en.cppreference.com/w/cpp/io/basic_stringbuf"