Share via

basic_stringbuf Class

  • Article

Describes a stream buffer that controls the transmission of elements of type Elem, whose character traits are determined by the class Tr, to and from a sequence of elements stored in an array object.

template <class Elem, class Tr = char_traits<Elem>, 
   class Alloc = allocator<Elem> 
>
   class basic_stringbuf : public basic_streambuf<Elem, Tr>

Parameters

  • Alloc
    The allocator class.

  • Elem
    The type of the basic element of the string.

  • Tr
    The character traits specialized on the basic element of the string.

Remarks

The object is allocated, extended, and freed as necessary to accommodate changes in the sequence.

An object of class basic_stringbuf<Elem, Tr, Alloc> stores a copy of the ios_base::openmode argument from its constructor as its stringbuf mode mode:

  • If mode & ios_base::in is nonzero, the input buffer is accessible. For more information, see basic_streambuf Class.

  • If mode & ios_base::out is nonzero, the output buffer is accessible.

Constructors

basic_stringbuf

Constructs an object of type basic_stringbuf.

Typedefs

allocator_type

The type is a synonym for the template parameter Alloc.

char_type

Associates a type name with the Elem template parameter.

int_type

Makes this type within basic_filebuf's scope equivalent to the type of the same name in the Tr scope.

off_type

Makes this type within basic_filebuf's scope equivalent to the type of the same name in the Tr scope.

pos_type

Makes this type within basic_filebuf's scope equivalent to the type of the same name in the Tr scope.

traits_type

Associates a type name with the Tr template parameter.

Member Functions

overflow

A protected, virtual function that can be called when a new character is inserted into a full buffer.

pbackfail

The protected virtual member function tries to put back an element into the input buffer, then makes it the current element (pointed to by the next pointer).

seekoff

The protected virtual member function tries to alter the current positions for the controlled streams.

seekpos

The protected virtual member function tries to alter the current positions for the controlled streams.

str

Sets or gets the text in a string buffer without changing the write position.

underflow

The protected virtual member function to extract the current element from the input stream.

Requirements

Header: <sstream>

Namespace: std

See Also

Reference

Thread Safety in the Standard C++ Library

iostream Programming

iostreams Conventions

Other Resources

basic_stringbuf Members

<sstream> Members