std::istreambuf_iterator

Template:cpp/iterator/istreambuf iterator/sidebar Template:ddcl list begin <tr class="t-dsc-header">

<td>

Defined in header <iterator>

</td>

<td></td> <td></td> </tr> <tr class="t-dcl ">

<td class="t-dcl-nopad">

template< class CharT, class Traits = std::char_traits<CharT> >

class istreambuf_iterator : public std::iterator< std::input_iterator_tag,
                                                  CharT,
                                                  typename Traits::off_type,
                                                  /*unspecified*/,

                                                  CharT >

</td>

<td class="t-dcl-nopad"> </td> <td class="t-dcl-nopad"> </td> </tr> Template:ddcl list end

std::istreambuf_iterator is a single-pass input iterator that reads successive characters from the Template:cpp object for which it was constructed. The actual read operation is performed when the iterator is incremented, not when it is dereferenced. The first character may be read when the iterator is constructed or when the first dereferencing is done. Otherwise, dereferencing only returns a copy of the most recently read character.

The default-constructed std::istreambuf_iterator is known as the end-of-stream iterator. When a valid std::istreambuf_iterator reaches the end of the underlying stream, it becomes equal to the end-of-stream iterator. Dereferencing or incrementing it further invokes undefined behavior.

std::istreambuf_iterator has a trivial copy constructor, a constexpr default constructor, and a trivial destructor.

Member functions

(constructor)	constructs a new istreambuf_iterator (public member function)
(destructor) (implicitly declared)	destructs an istreambuf_iterator (public member function)
operator*operator-> (since C++11)	obtains a copy of the current character accesses a member of the current character, if CharT has members (public member function of Template:cpp/iterator/istreamubuf iterator/title)
operator++operator++(int)	advances the istreambuf_iterator (public member function of Template:cpp/iterator/istreamubuf iterator/title)
equal	tests if both istreambuf_iterators are end-of-stream or if both are valid (public member function of Template:cpp/iterator/istreamubuf iterator/title)

Non-member functions

operator==operator!=

compares two istreambuf_iterators (function template)

See also

Template:cpp/iterator/dcl list ostreambuf iteratorTemplate:cpp/iterator/dcl list istream iterator