| Home | Libraries | People | FAQ | More

## Class template basic_ivectorstream

boost::interprocess::basic_ivectorstream

## Synopsis

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

    template<typename CharVector, typename CharTraits>
    class basic_ivectorstream :
      public std::basic_istream< CharVector::value_type, CharTraits >
    {
    public:
      // types
      typedef CharVector                                                               vector_type;
      typedef std::basic_ios< typename CharVector::value_type, 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_ivectorstream(std::ios_base::openmode = std::ios_base::in);
      template<typename VectorParameter>
        basic_ivectorstream(const VectorParameter &,
                            std::ios_base::openmode = std::ios_base::in);

      // public member functions
      basic_vectorbuf< CharVector, CharTraits > * rdbuf() const;
      void swap_vector(vector_type &);
      const vector_type & vector() const;
      void reserve(typename vector_type::size_type);
      void clear();
    };

## Description

A basic_istream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string

### `basic_ivectorstream` public construct/copy/destruct

1.     basic_ivectorstream(std::ios_base::openmode mode = std::ios_base::in);

   Constructor. Throws if vector_type default constructor throws.

2.     template<typename VectorParameter>
         basic_ivectorstream(const VectorParameter & param,
                             std::ios_base::openmode mode = std::ios_base::in);

   Constructor. Throws if vector_type(const VectorParameter &param) throws.

### `basic_ivectorstream` public member functions

1.     basic_vectorbuf< CharVector, CharTraits > * rdbuf() const;

   Returns the address of the stored stream buffer.

2.     void swap_vector(vector_type & vect);

   Swaps the underlying vector with the passed vector. This function resets the read position in the stream. Does not throw.

3.     const vector_type & vector() const;

   Returns a const reference to the internal vector. Does not throw.

4.     void reserve(typename vector_type::size_type size);

   Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws.

5.     void clear();

   Calls clear() method of the internal vector. Resets the stream to the first position.