.TH "std::istreambuf_iterator< _CharT, _Traits >" 3cxx "Thu Feb 16 2023" "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 <streambuf_iterator\&.h>\fP
.PP
Inherits \fBstd::iterator< input_iterator_tag, _CharT, _Traits::off_type, _CharT *, _CharT >\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef _Traits::off_type \fBdifference_type\fP"
.br
.RI "Distance between iterators is represented as this type\&. "
.ti -1c
.RI "typedef \fBinput_iterator_tag\fP \fBiterator_category\fP"
.br
.RI "One of the \fBtag types\fP\&. "
.ti -1c
.RI "typedef _CharT * \fBpointer\fP"
.br
.RI "This type represents a pointer-to-value_type\&. "
.ti -1c
.RI "typedef _CharT \fBreference\fP"
.br
.RI "This type represents a reference-to-value_type\&. "
.ti -1c
.RI "typedef _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 "typedef _CharT \fBchar_type\fP"
.br
.RI "Public typedefs\&. "
.ti -1c
.RI "typedef _Traits \fBtraits_type\fP"
.br
.RI "Public typedefs\&. "
.ti -1c
.RI "typedef _Traits::int_type \fBint_type\fP"
.br
.RI "Public typedefs\&. "
.ti -1c
.RI "typedef \fBbasic_streambuf\fP< _CharT, _Traits > \fBstreambuf_type\fP"
.br
.RI "Public typedefs\&. "
.ti -1c
.RI "typedef \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 "constexpr \fBistreambuf_iterator\fP () noexcept"
.br
.RI "Construct end of input stream iterator\&. "
.ti -1c
.RI "\fBistreambuf_iterator\fP (const \fBistreambuf_iterator\fP &) noexcept=default"
.br
.ti -1c
.RI "\fBistreambuf_iterator\fP (\fBistream_type\fP &__s) noexcept"
.br
.RI "Construct start of input stream iterator\&. "
.ti -1c
.RI "\fBistreambuf_iterator\fP (\fBstreambuf_type\fP *__s) noexcept"
.br
.RI "Construct start of streambuf iterator\&. "
.ti -1c
.RI "bool \fBequal\fP (const \fBistreambuf_iterator\fP &__b) const"
.br
.RI "Return true both iterators are end or both are not end\&. "
.ti -1c
.RI "\fBchar_type\fP \fBoperator*\fP () const"
.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 (const \fBistreambuf_iterator\fP &) noexcept=default"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<bool _IsMove, typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, _CharT2 * >::__type \fB__copy_move_a2\fP (\fBistreambuf_iterator\fP< _CharT2 >, \fBistreambuf_iterator\fP< _CharT2 >, _CharT2 *)"
.br
.ti -1c
.RI "template<typename _CharT2 , typename _Size > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, _CharT2 * >::__type \fB__copy_n_a\fP (\fBistreambuf_iterator\fP< _CharT2 >, _Size, _CharT2 *, bool)"
.br
.ti -1c
.RI "template<typename _CharT2 , typename _Distance > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, void >::__type \fBadvance\fP (\fBistreambuf_iterator\fP< _CharT2 > &, _Distance)"
.br
.ti -1c
.RI "template<typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, \fBostreambuf_iterator\fP< _CharT2 > >::__type \fBcopy\fP (\fBistreambuf_iterator\fP< _CharT2 >, \fBistreambuf_iterator\fP< _CharT2 >, \fBostreambuf_iterator\fP< _CharT2 >)"
.br
.ti -1c
.RI "template<typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, \fBistreambuf_iterator\fP< _CharT2 > >::__type \fBfind\fP (\fBistreambuf_iterator\fP< _CharT2 >, \fBistreambuf_iterator\fP< _CharT2 >, const _CharT2 &)"
.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\&. 
.PP
Definition at line \fB50\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "template<typename _CharT , typename _Traits > typedef _CharT \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::char_type"

.PP
Public typedefs\&. 
.PP
Definition at line \fB66\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "typedef _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 \fB134\fP of file \fBstl_iterator_base_types\&.h\fP\&.
.SS "template<typename _CharT , typename _Traits > typedef _Traits::int_type \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::int_type"

.PP
Public typedefs\&. 
.PP
Definition at line \fB68\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _Traits > typedef \fBbasic_istream\fP<_CharT, _Traits> \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::istream_type"

.PP
Public typedefs\&. 
.PP
Definition at line \fB70\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "typedef \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 \fB130\fP of file \fBstl_iterator_base_types\&.h\fP\&.
.SS "typedef _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 \fB136\fP of file \fBstl_iterator_base_types\&.h\fP\&.
.SS "typedef _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 \fB138\fP of file \fBstl_iterator_base_types\&.h\fP\&.
.SS "template<typename _CharT , typename _Traits > typedef \fBbasic_streambuf\fP<_CharT, _Traits> \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::streambuf_type"

.PP
Public typedefs\&. 
.PP
Definition at line \fB69\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _Traits > typedef _Traits \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::traits_type"

.PP
Public typedefs\&. 
.PP
Definition at line \fB67\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "typedef _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 \fB132\fP of file \fBstl_iterator_base_types\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _CharT , typename _Traits > constexpr \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 \fB114\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _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 \fB129\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _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 \fB133\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _CharT , typename _Traits > bool \fBstd::istreambuf_iterator\fP< _CharT, _Traits >::equal (const \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 \fB193\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _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 \fB145\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _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 \fB161\fP of file \fBstreambuf_iterator\&.h\fP\&.
.SS "template<typename _CharT , typename _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 \fB175\fP of file \fBstreambuf_iterator\&.h\fP\&.

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