Namespaces
Variants
Views
Actions

std::basic_stringbuf

From cppreference.com
< cpp‎ | io
Revision as of 15:46, 23 April 2013 by Dieram3 (Talk | contribs)

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

Member types

Template:cpp/io/dcl list char typeTemplate:cpp/io/dcl list traits typeTemplate:cpp/io/dcl list int typeTemplate:cpp/io/dcl list pos typeTemplate:cpp/io/dcl list off typeTemplate:cpp/io/dcl list allocator type
Member type Definition

Member functions

Template:cpp/io/basic stringbuf/dcl list constructorTemplate:cpp/io/basic stringbuf/dcl list operator=Template:cpp/io/basic stringbuf/dcl list swapTemplate:cpp/io/basic stringbuf/dcl list destructorTemplate:cpp/io/basic stringbuf/dcl list strTemplate:cpp/io/basic stringbuf/dcl list underflowTemplate:cpp/io/basic stringbuf/dcl list pbackfailTemplate:cpp/io/basic stringbuf/dcl list overflowTemplate:cpp/io/basic stringbuf/dcl list setbufTemplate:cpp/io/basic stringbuf/dcl list seekoffTemplate:cpp/io/basic stringbuf/dcl list seekpos

Public member functions

Protected member functions

Non-member functions

Template:cpp/io/basic stringbuf/dcl list swap2

Inherited from std::basic_streambuf

Member types

Member type Definition
char_type CharT[edit]
traits_type Traits[edit]
int_type Traits::int_type[edit]
pos_type Traits::pos_type[edit]
off_type Traits::off_type[edit]

Member functions

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

Protected member functions

constructs a basic_streambuf object
(protected member function) [edit]
(C++11)
replaces a basic_streambuf object
(protected member function) [edit]
(C++11)
swaps two basic_streambuf objects
(protected member function) [edit]
Locales
[virtual]
changes the associated locale
(virtual protected member function of std::basic_streambuf) [edit]
Positioning
[virtual]
replaces the buffer with user-defined array, if permitted
(virtual protected member function of std::basic_streambuf) [edit]
[virtual]
repositions the next pointer in the input sequence, output sequence, or both, using relative addressing
(virtual protected member function of std::basic_streambuf) [edit]
[virtual]
repositions the next pointer in the input sequence, output sequence, or both using absolute addressing
(virtual protected member function of std::basic_streambuf) [edit]
[virtual]
synchronizes the buffers with the associated character sequence
(virtual protected member function of std::basic_streambuf) [edit]
Get area
[virtual]
obtains the number of characters available for input in the associated input sequence, if known
(virtual protected member function of std::basic_streambuf) [edit]
[virtual]
reads characters from the associated input sequence to the get area
(virtual protected member function of std::basic_streambuf) [edit]
[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) [edit]
[virtual]
reads multiple characters from the input sequence
(virtual protected member function of std::basic_streambuf) [edit]
returns a pointer to the beginning, current character and the end of the get area
(protected member function) [edit]
advances the next pointer in the input sequence
(protected member function) [edit]
repositions the beginning, next, and end pointers of the input sequence
(protected member function) [edit]
Put area
[virtual]
writes multiple characters to the output sequence
(virtual protected member function of std::basic_streambuf) [edit]
[virtual]
writes characters to the associated output sequence from the put area
(virtual protected member function of std::basic_streambuf) [edit]
returns a pointer to the beginning, current character and the end of the put area
(protected member function) [edit]
advances the next pointer of the output sequence
(protected member function) [edit]
repositions the beginning, next, and end pointers of the output sequence
(protected member function) [edit]
Putback
[virtual]
puts a character back into the input sequence, possibly modifying the input sequence
(virtual protected member function of std::basic_streambuf) [edit]