.TH "std::istreambuf_iterator< _CharT, _Traits >" 3cxx "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::istreambuf_iterator< _CharT, _Traits > \- Provides input iterator semantics for streambufs\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBstd::iterator< input_iterator_tag, _CharT, _Traits::off_type, _CharT *, _CharT >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "\fBtypedef\fP _Traits::off_type \fBdifference_type\fP" .br .RI "Distance between iterators is represented as this type\&. " .ti -1c .RI "\fBtypedef\fP \fBinput_iterator_tag\fP \fBiterator_category\fP" .br .RI "One of the \fBtag types\fP\&. " .ti -1c .RI "\fBtypedef\fP _CharT * \fBpointer\fP" .br .RI "This type represents a pointer-to-value_type\&. " .ti -1c .RI "\fBtypedef\fP _CharT \fBreference\fP" .br .RI "This type represents a reference-to-value_type\&. " .ti -1c .RI "\fBtypedef\fP _CharT \fBvalue_type\fP" .br .RI "The type 'pointed to' by the iterator\&. " .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBtypedef\fP _CharT \fBchar_type\fP" .br .RI "Public typedefs\&. " .ti -1c .RI "\fBtypedef\fP _Traits \fBtraits_type\fP" .br .RI "Public typedefs\&. " .ti -1c .RI "\fBtypedef\fP _Traits::int_type \fBint_type\fP" .br .RI "Public typedefs\&. " .ti -1c .RI "\fBtypedef\fP \fBbasic_streambuf\fP< _CharT, _Traits > \fBstreambuf_type\fP" .br .RI "Public typedefs\&. " .ti -1c .RI "\fBtypedef\fP \fBbasic_istream\fP< _CharT, _Traits > \fBistream_type\fP" .br .RI "Public typedefs\&. " .in -1c .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBconstexpr\fP \fBistreambuf_iterator\fP () \fBnoexcept\fP" .br .RI "Construct end of input stream iterator\&. " .ti -1c .RI "\fBistreambuf_iterator\fP (\fBconst\fP \fBistreambuf_iterator\fP &) \fBnoexcept\fP=\fBdefault\fP" .br .ti -1c .RI "\fBistreambuf_iterator\fP (\fBistream_type\fP &\fB__s\fP) \fBnoexcept\fP" .br .RI "Construct start of input stream iterator\&. " .ti -1c .RI "\fBistreambuf_iterator\fP (\fBstreambuf_type\fP *\fB__s\fP) \fBnoexcept\fP" .br .RI "Construct start of streambuf iterator\&. " .ti -1c .RI "bool \fBequal\fP (\fBconst\fP \fBistreambuf_iterator\fP &__b) \fBconst\fP" .br .RI "Return true both iterators are end or both are not end\&. " .ti -1c .RI "\fBchar_type\fP \fBoperator*\fP () \fBconst\fP" .br .RI "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\&. " .ti -1c .RI "\fBistreambuf_iterator\fP & \fBoperator++\fP ()" .br .RI "Advance the iterator\&. Calls streambuf\&.sbumpc()\&. " .ti -1c .RI "\fBistreambuf_iterator\fP \fBoperator++\fP (int)" .br .RI "Advance the iterator\&. Calls streambuf\&.sbumpc()\&. " .ti -1c .RI "\fBistreambuf_iterator\fP & \fBoperator=\fP (\fBconst\fP \fBistreambuf_iterator\fP &) \fBnoexcept\fP=\fBdefault\fP" .br .in -1c .SS "Friends" .in +1c .ti -1c .RI "template __gnu_cxx::__enable_if< __is_char< \fB_CharT2\fP >::__value, \fB_CharT2\fP * >::__type \fB__copy_move_a2\fP (\fBistreambuf_iterator\fP< \fB_CharT2\fP >, \fBistreambuf_iterator\fP< \fB_CharT2\fP >, \fB_CharT2\fP *)" .br .ti -1c .RI "template<\fBtypename\fP \fB_CharT2\fP , \fBtypename\fP \fB_Distance\fP > __gnu_cxx::__enable_if< __is_char< \fB_CharT2\fP >::__value, \fBvoid\fP >::__type \fBadvance\fP (\fBistreambuf_iterator\fP< \fB_CharT2\fP > &, \fB_Distance\fP)" .br .ti -1c .RI "template<\fBtypename\fP \fB_CharT2\fP > __gnu_cxx::__enable_if< __is_char< \fB_CharT2\fP >::__value, \fBostreambuf_iterator\fP< \fB_CharT2\fP > >::__type \fBcopy\fP (\fBistreambuf_iterator\fP< \fB_CharT2\fP >, \fBistreambuf_iterator\fP< \fB_CharT2\fP >, \fBostreambuf_iterator\fP< \fB_CharT2\fP >)" .br .ti -1c .RI "template<\fBtypename\fP \fB_CharT2\fP > __gnu_cxx::__enable_if< __is_char< \fB_CharT2\fP >::__value, \fBistreambuf_iterator\fP< \fB_CharT2\fP > >::__type \fBfind\fP (\fBistreambuf_iterator\fP< \fB_CharT2\fP >, \fBistreambuf_iterator\fP< \fB_CharT2\fP >, \fBconst\fP \fB_CharT2\fP &)" .br .in -1c .SH "Detailed Description" .PP .SS "template<\fBtypename\fP _CharT, \fBtypename\fP _Traits> .br class std::istreambuf_iterator< _CharT, _Traits >"Provides input iterator semantics for streambufs\&. .PP Definition at line \fB50\fP of file \fBstreambuf_iterator\&.h\fP\&. .SH "Member Typedef Documentation" .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP _CharT \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::char_type" .PP Public typedefs\&. .PP Definition at line \fB64\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "\fBtypedef\fP _Traits::off_type \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT >::difference_type\fC [inherited]\fP" .PP Distance between iterators is represented as this type\&. .PP Definition at line \fB125\fP of file \fBstl_iterator_base_types\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP _Traits::int_type \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::int_type" .PP Public typedefs\&. .PP Definition at line \fB66\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP \fBbasic_istream\fP<_CharT, _Traits> \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istream_type" .PP Public typedefs\&. .PP Definition at line \fB68\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "\fBtypedef\fP \fBinput_iterator_tag\fP \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT >::iterator_category\fC [inherited]\fP" .PP One of the \fBtag types\fP\&. .PP Definition at line \fB121\fP of file \fBstl_iterator_base_types\&.h\fP\&. .SS "\fBtypedef\fP _CharT * \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT >::pointer\fC [inherited]\fP" .PP This type represents a pointer-to-value_type\&. .PP Definition at line \fB127\fP of file \fBstl_iterator_base_types\&.h\fP\&. .SS "\fBtypedef\fP _CharT \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT >::reference\fC [inherited]\fP" .PP This type represents a reference-to-value_type\&. .PP Definition at line \fB129\fP of file \fBstl_iterator_base_types\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP \fBbasic_streambuf\fP<_CharT, _Traits> \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::streambuf_type" .PP Public typedefs\&. .PP Definition at line \fB67\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP _Traits \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::traits_type" .PP Public typedefs\&. .PP Definition at line \fB65\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "\fBtypedef\fP _CharT \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT >::value_type\fC [inherited]\fP" .PP The type 'pointed to' by the iterator\&. .PP Definition at line \fB123\fP of file \fBstl_iterator_base_types\&.h\fP\&. .SH "Constructor & Destructor Documentation" .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBconstexpr\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istreambuf_iterator ()\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP" .PP Construct end of input stream iterator\&. .PP Definition at line \fB107\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istreambuf_iterator (\fBistream_type\fP & __s)\fC [inline]\fP, \fC [noexcept]\fP" .PP Construct start of input stream iterator\&. .PP Definition at line \fB117\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istreambuf_iterator (\fBstreambuf_type\fP * __s)\fC [inline]\fP, \fC [noexcept]\fP" .PP Construct start of streambuf iterator\&. .PP Definition at line \fB121\fP of file \fBstreambuf_iterator\&.h\fP\&. .SH "Member Function Documentation" .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > bool \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::equal (\fBconst\fP \fBistreambuf_iterator\fP< _CharT, _Traits > & __b) const\fC [inline]\fP" .PP Return true both iterators are end or both are not end\&. .PP Definition at line \fB181\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::operator* () const\fC [inline]\fP" .PP 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\&. .PP Definition at line \fB133\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBistreambuf_iterator\fP & \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::operator++ ()\fC [inline]\fP" .PP Advance the iterator\&. Calls streambuf\&.sbumpc()\&. .PP Definition at line \fB149\fP of file \fBstreambuf_iterator\&.h\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBistreambuf_iterator\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::operator++ (int)\fC [inline]\fP" .PP Advance the iterator\&. Calls streambuf\&.sbumpc()\&. .PP Definition at line \fB163\fP of file \fBstreambuf_iterator\&.h\fP\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.