.TH "std::istreambuf_iterator< _CharT, _Traits >" 3 "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::istreambuf_iterator< _CharT, _Traits > \- Provides input iterator semantics for streambufs\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <iterator>\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 \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 "\fBusing\fP \fBpointer\fP"
.br
.RI "Public typedefs\&. "
.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 () noexcept"
.br
.RI "Construct end of input stream iterator\&. "
.ti -1c
.RI "\fBistreambuf_iterator\fP (\fBconst\fP \fBistreambuf_iterator\fP &) noexcept=\fBdefault\fP"
.br
.ti -1c
.RI "\fBistreambuf_iterator\fP (\fBistream_type\fP &\fB__s\fP) noexcept"
.br
.RI "Construct start of input stream iterator\&. "
.ti -1c
.RI "\fBistreambuf_iterator\fP (\fBstreambuf_type\fP *\fB__s\fP) noexcept"
.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 &) noexcept=\fBdefault\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<bool _IsMove, typename \fB_CharT2\fP > __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<typename \fB_CharT2\fP , typename _Size > __gnu_cxx::__enable_if< __is_char< \fB_CharT2\fP >::__value, \fB_CharT2\fP * >::__type \fB__copy_n_a\fP (\fBistreambuf_iterator\fP< \fB_CharT2\fP >, _Size, \fB_CharT2\fP *, bool)"
.br
.ti -1c
.RI "template<typename \fB_CharT2\fP , typename \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<typename \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<typename \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<typename _CharT, typename _Traits>
.br
class std::istreambuf_iterator< _CharT, _Traits >"Provides input iterator semantics for streambufs\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "template<typename _CharT , typename _Traits > \fBtypedef\fP _CharT \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::char_type"

.PP
Public typedefs\&. 
.SS "\fBtypedef\fP _Traits::off_type  \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT  >::difference_type\fR [inherited]\fP"

.PP
Distance between iterators is represented as this type\&. 
.SS "template<typename _CharT , typename _Traits > \fBtypedef\fP _Traits::int_type \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::int_type"

.PP
Public typedefs\&. 
.SS "template<typename _CharT , typename _Traits > \fBtypedef\fP \fBbasic_istream\fP<_CharT, _Traits> \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istream_type"

.PP
Public typedefs\&. 
.SS "\fBtypedef\fP \fBinput_iterator_tag\fP  \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT  >::iterator_category\fR [inherited]\fP"

.PP
One of the \fBtag types\fP\&. 
.SS "template<typename _CharT , typename _Traits > \fBusing\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::pointer"

.PP
Public typedefs\&. 
.SS "\fBtypedef\fP _CharT  \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT  >::reference\fR [inherited]\fP"

.PP
This type represents a reference-to-value_type\&. 
.SS "template<typename _CharT , typename _Traits > \fBtypedef\fP \fBbasic_streambuf\fP<_CharT, _Traits> \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::streambuf_type"

.PP
Public typedefs\&. 
.SS "template<typename _CharT , typename _Traits > \fBtypedef\fP _Traits \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::traits_type"

.PP
Public typedefs\&. 
.SS "\fBtypedef\fP _CharT  \fBstd::iterator\fP< \fBinput_iterator_tag\fP , _CharT , _Traits::off_type , _CharT * , _CharT  >::value_type\fR [inherited]\fP"

.PP
The type 'pointed to' by the iterator\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _CharT , typename _Traits > \fBconstexpr\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istreambuf_iterator ()\fR [inline]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"

.PP
Construct end of input stream iterator\&. 
.SS "template<typename _CharT , typename _Traits > \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istreambuf_iterator (\fBistream_type\fP & __s)\fR [inline]\fP, \fR [noexcept]\fP"

.PP
Construct start of input stream iterator\&. 
.SS "template<typename _CharT , typename _Traits > \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istreambuf_iterator (\fBstreambuf_type\fP * __s)\fR [inline]\fP, \fR [noexcept]\fP"

.PP
Construct start of streambuf iterator\&. 
.SH "Member Function Documentation"
.PP 
.SS "template<typename _CharT , typename _Traits > bool \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::equal (\fBconst\fP \fBistreambuf_iterator\fP< _CharT, _Traits > & __b) const\fR [inline]\fP"

.PP
Return true both iterators are end or both are not end\&. 
.SS "template<typename _CharT , typename _Traits > \fBchar_type\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::operator* () const\fR [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\&. 
.SS "template<typename _CharT , typename _Traits > \fBistreambuf_iterator\fP & \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::operator++ ()\fR [inline]\fP"

.PP
Advance the iterator\&. Calls streambuf\&.sbumpc()\&. 
.PP
References \fBstd::basic_streambuf< _CharT, _Traits >::sbumpc()\fP, and \fBstd::basic_streambuf< _CharT, _Traits >::sgetc()\fP\&.
.SS "template<typename _CharT , typename _Traits > \fBistreambuf_iterator\fP \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::operator++ (int)\fR [inline]\fP"

.PP
Advance the iterator\&. Calls streambuf\&.sbumpc()\&. 
.PP
References \fBstd::forward()\fP, \fBstd::basic_streambuf< _CharT, _Traits >::sbumpc()\fP, and \fBstd::basic_streambuf< _CharT, _Traits >::sgetc()\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.