Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
PrevUpHomeNext

Class template basic_obufferstream

boost::interprocess::basic_obufferstream

Synopsis

// In header: <boost/interprocess/streams/bufferstream.hpp>

template<typename CharT, typename CharTraits> 
class basic_obufferstream {
public:
  // types
  typedef std::basic_ios< CharT, CharTraits >::char_type       char_type;  
  typedef std::basic_ios< char_type, CharTraits >::int_type    int_type;   
  typedef std::basic_ios< char_type, CharTraits >::pos_type    pos_type;   
  typedef std::basic_ios< char_type, CharTraits >::off_type    off_type;   
  typedef std::basic_ios< char_type, CharTraits >::traits_type traits_type;

  // construct/copy/destruct
  basic_obufferstream(std::ios_base::openmode = std::ios_base::out);
  basic_obufferstream(CharT *, std::size_t, 
                      std::ios_base::openmode = std::ios_base::out);
  ~basic_obufferstream();

  // public member functions
  basic_bufferbuf< CharT, CharTraits > * rdbuf() const;
  std::pair< CharT *, std::size_t > buffer() const;
  void buffer(CharT *, std::size_t);
};

Description

A basic_ostream class that uses a fixed size character buffer as its formatting buffer.

basic_obufferstream public construct/copy/destruct

  1. basic_obufferstream(std::ios_base::openmode mode = std::ios_base::out);

    Constructor. Does not throw.

  2. basic_obufferstream(CharT * buffer, std::size_t length, 
                        std::ios_base::openmode mode = std::ios_base::out);

    Constructor. Assigns formatting buffer. Does not throw.

  3. ~basic_obufferstream();

basic_obufferstream public member functions

  1. basic_bufferbuf< CharT, CharTraits > * rdbuf() const;

    Returns the address of the stored stream buffer.

  2. std::pair< CharT *, std::size_t > buffer() const;

    Returns the pointer and size of the internal buffer. Does not throw.

  3. void buffer(CharT * buffer, std::size_t length);

    Sets the underlying buffer to a new value. Resets stream position. Does not throw.


PrevUpHomeNext