plucky (3) std::istreambuf_iterator.3cxx.gz

NAME

       std::istreambuf_iterator< _CharT, _Traits > - Provides input iterator semantics for streambufs.

SYNOPSIS

       #include <iterator>

       Inherits std::iterator< input_iterator_tag, _CharT, _Traits::off_type, _CharT *, _CharT >.

   Public Types
       typedef _Traits::off_type difference_type
           Distance between iterators is represented as this type.
       typedef input_iterator_tag iterator_category
           One of the tag types.
       typedef _CharT reference
           This type represents a reference-to-value_type.
       typedef _CharT value_type
           The type 'pointed to' by the iterator.

           using pointer = void
               Public typedefs.
           typedef _CharT char_type
               Public typedefs.
           typedef _Traits traits_type
               Public typedefs.
           typedef _Traits::int_type int_type
               Public typedefs.
           typedef basic_streambuf< _CharT, _Traits > streambuf_type
               Public typedefs.
           typedef basic_istream< _CharT, _Traits > istream_type
               Public typedefs.

   Public Member Functions
       constexpr istreambuf_iterator () noexcept
           Construct end of input stream iterator.
       istreambuf_iterator (const istreambuf_iterator &) noexcept=default
       istreambuf_iterator (istream_type &__s) noexcept
           Construct start of input stream iterator.
       istreambuf_iterator (streambuf_type *__s) noexcept
           Construct start of streambuf iterator.
       bool equal (const istreambuf_iterator &__b) const
           Return true both iterators are end or both are not end.
       char_type operator* () const
           Return the current character pointed to by iterator. This returns streambuf.sgetc(). It cannot be
           assigned. NB: The result of operator*() on an end of stream is undefined.
       istreambuf_iterator & operator++ ()
           Advance the iterator. Calls streambuf.sbumpc().
       istreambuf_iterator operator++ (int)
           Advance the iterator. Calls streambuf.sbumpc().
       istreambuf_iterator & operator= (const istreambuf_iterator &) noexcept=default

   Friends
       template<bool _IsMove, typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, _CharT2
           * >::__type __copy_move_a2 (istreambuf_iterator< _CharT2 >, istreambuf_iterator< _CharT2 >, _CharT2
           *)
       template<typename _CharT2 , typename _Size > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value,
           _CharT2 * >::__type __copy_n_a (istreambuf_iterator< _CharT2 >, _Size, _CharT2 *, bool)
       template<typename _CharT2 , typename _Distance > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value,
           void >::__type advance (istreambuf_iterator< _CharT2 > &, _Distance)
       template<typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, ostreambuf_iterator<
           _CharT2 > >::__type copy (istreambuf_iterator< _CharT2 >, istreambuf_iterator< _CharT2 >,
           ostreambuf_iterator< _CharT2 >)
       template<typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, istreambuf_iterator<
           _CharT2 > >::__type find (istreambuf_iterator< _CharT2 >, istreambuf_iterator< _CharT2 >, const
           _CharT2 &)

Detailed Description

   template<typename _CharT, typename _Traits>
       class std::istreambuf_iterator< _CharT, _Traits >"Provides input iterator semantics for streambufs.

Member Typedef Documentation

   template<typename _CharT , typename _Traits > typedef _CharT std::istreambuf_iterator< _CharT, _Traits
       >::char_type
       Public typedefs.

   typedef _Traits::off_type  std::iterator< input_iterator_tag , _CharT , _Traits::off_type , _CharT * , _CharT
       >::difference_type [inherited]
       Distance between iterators is represented as this type.

   template<typename _CharT , typename _Traits > typedef _Traits::int_type std::istreambuf_iterator< _CharT,
       _Traits >::int_type
       Public typedefs.

   template<typename _CharT , typename _Traits > typedef basic_istream<_CharT, _Traits>
       std::istreambuf_iterator< _CharT, _Traits >::istream_type
       Public typedefs.

   typedef input_iterator_tag  std::iterator< input_iterator_tag , _CharT , _Traits::off_type , _CharT * ,
       _CharT  >::iterator_category [inherited]
       One of the tag types.

   template<typename _CharT , typename _Traits > using std::istreambuf_iterator< _CharT, _Traits >::pointer =
       void
       Public typedefs.

   typedef _CharT  std::iterator< input_iterator_tag , _CharT , _Traits::off_type , _CharT * , _CharT
       >::reference [inherited]
       This type represents a reference-to-value_type.

   template<typename _CharT , typename _Traits > typedef basic_streambuf<_CharT, _Traits>
       std::istreambuf_iterator< _CharT, _Traits >::streambuf_type
       Public typedefs.

   template<typename _CharT , typename _Traits > typedef _Traits std::istreambuf_iterator< _CharT, _Traits
       >::traits_type
       Public typedefs.

   typedef _CharT  std::iterator< input_iterator_tag , _CharT , _Traits::off_type , _CharT * , _CharT
       >::value_type [inherited]
       The type 'pointed to' by the iterator.

Constructor & Destructor Documentation

   template<typename _CharT , typename _Traits > constexpr std::istreambuf_iterator< _CharT, _Traits
       >::istreambuf_iterator () [inline],  [constexpr],  [noexcept]
       Construct end of input stream iterator.

   template<typename _CharT , typename _Traits > std::istreambuf_iterator< _CharT, _Traits
       >::istreambuf_iterator (istream_type & __s) [inline],  [noexcept]
       Construct start of input stream iterator.

   template<typename _CharT , typename _Traits > std::istreambuf_iterator< _CharT, _Traits
       >::istreambuf_iterator (streambuf_type * __s) [inline],  [noexcept]
       Construct start of streambuf iterator.

Member Function Documentation

   template<typename _CharT , typename _Traits > bool std::istreambuf_iterator< _CharT, _Traits >::equal (const
       istreambuf_iterator< _CharT, _Traits > & __b) const [inline]
       Return true both iterators are end or both are not end.

   template<typename _CharT , typename _Traits > char_type std::istreambuf_iterator< _CharT, _Traits
       >::operator* () const [inline]
       Return the current character pointed to by iterator. This returns streambuf.sgetc(). It cannot be
       assigned. NB: The result of operator*() on an end of stream is undefined.

   template<typename _CharT , typename _Traits > istreambuf_iterator & std::istreambuf_iterator< _CharT, _Traits
       >::operator++ () [inline]
       Advance the iterator. Calls streambuf.sbumpc().

   template<typename _CharT , typename _Traits > istreambuf_iterator std::istreambuf_iterator< _CharT, _Traits
       >::operator++ (int) [inline]
       Advance the iterator. Calls streambuf.sbumpc().

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

                                                    libstdc++  std::istreambuf_iterator< _CharT, _Traits >(3cxx)