STD::ISTREAM_ITERATOR(3)

✨ NAME ✨

okay so bestie, meet std::istream_iterator< _Tp, _CharT, _Traits, _Dist > — it's the whole vibe of Provides input iterator semantics for streams. 💖

like literally, it lets you treat a stream like an iterator. iconic behaviour, no cap.

---

🦋 SYNOPSIS 🦋

first things first, you gotta pull it in:

#include <iterator>

and heads up — it Inherits from:

std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >

it's giving "I got everything from my parent class and I'm thriving". 🫶

🎀 Public Types 🎀

the little type besties it brings along:

• typedef _CharT char_type
• typedef ptrdiff_t difference_type — Distance between iterators is represented as this type. (fr fr, that's literally what it's for)
• typedef basic_istream< _CharT, _Traits > istream_type
• typedef input_iterator_tag iterator_category — One of the tag types. 🏷️
• typedef const _Tp * pointer — This type represents a pointer-to-value_type.
• typedef const _Tp & reference — This type represents a reference-to-value_type.
• typedef _Traits traits_type
• typedef _Tp value_type — The type "pointed to" by the iterator. 💅

💅 Public Member Functions 💅

the moves it can do:

• constexpr istream_iterator () noexcept(/*conditional */) — Construct end of input stream iterator. (the classic "end" one, we love her)
• constexpr istream_iterator (const istream_iterator &__obj) noexcept(/*conditional */)
• constexpr istream_iterator (default_sentinel_t) noexcept(is_nothrow_default_constructible_v< _Tp >)
• istream_iterator (istream_type &__s) — Construct start of input stream iterator. (the "begin" one, the main character ✨)
• const _Tp & operator* () const noexcept
• istream_iterator & operator++ ()
• istream_iterator operator++ (int)
• const _Tp * operator-> () const noexcept
• istream_iterator & operator= (const istream_iterator &)=default

🌸 Friends 🌸

the besties it fw:

• bool operator== (const istream_iterator &__i, default_sentinel_t) noexcept
• bool operator== (const istream_iterator &__x, const istream_iterator &__y) noexcept — Return true if the iterators refer to the same stream, or are both at end-of-stream. 🫶

---

💖 Detailed Description 💖

here's the full template glow-up:

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>, typename _Dist = ptrdiff_t>
class std::istream_iterator< _Tp, _CharT, _Traits, _Dist >

and what does it do? "Provides input iterator semantics for streams." that's it, that's the whole personality. 😌

---

🧚 Member Typedef Documentation 🧚

these ones are all inherited, so they came pre-loaded from std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >:

• typedef ptrdiff_t std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >::difference_type [inherited] — Distance between iterators is represented as this type.
• typedef input_iterator_tag std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >::iterator_category [inherited] — One of the tag types. 🏷️
• typedef const _Tp * std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >::pointer [inherited] — This type represents a pointer-to-value_type.
• typedef const _Tp & std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >::reference [inherited] — This type represents a reference-to-value_type.
• typedef _Tp std::iterator< input_iterator_tag, _Tp, ptrdiff_t, const _Tp *, const _Tp & >::value_type [inherited] — The type "pointed to" by the iterator.

---

⭐ Constructor & Destructor Documentation ⭐

🌈 the no-arg one

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>, typename _Dist = ptrdiff_t>
std::istream_iterator< _Tp, _CharT, _Traits, _Dist >::istream_iterator ()
[inline], [constexpr], [noexcept]

Construct end of input stream iterator. that's the whole job. 🎀

• Referenced by operator==.

🦋 the stream-taking one

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>, typename _Dist = ptrdiff_t>
std::istream_iterator< _Tp, _CharT, _Traits, _Dist >::istream_iterator
(istream_type & __s) [inline]

Construct start of input stream iterator. the beginning of the story, literally. ✨

• References std::__addressof().

---

🔥 Friends And Related Symbol Documentation 🔥

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>, typename _Dist = ptrdiff_t>
bool operator== (const istream_iterator< _Tp, _CharT, _Traits, _Dist > & __x,
                 const istream_iterator< _Tp, _CharT, _Traits, _Dist > & __y)
[friend]

Return true if the iterators refer to the same stream, or are both at end-of-stream. so like, same stream = besties, both at the end = also besties. equality ate and left no crumbs. 💅

• References istream_iterator().

---

👑 Author 👑

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

like, nobody hand-wrote this, the robot did it, and honestly? slay. 🤖✨

---

no cap, this page came straight out of the libstdc++ manual — the Library Functions Manual, section (3), the one and only std::istre...s, _Dist >(3). 🎀 that's the whole sign-off bestie, go read your streams. 💖🌸🦋