STD::ISTREAM_ITERATOR(3cxx)

📦
version 14-20240412 · 21 versions
, in ubuntu noble

💅 std::istream_iterator< _Tp, _CharT, _Traits, _Dist > — the 3cxx glow-up ✨

okay so bestie, picture this: you've got a stream (yes, like std::cin, the whole vibe) and you want to walk through it like it's a playlist. that's literally what this class does. it's from the <iterator> header, and it's a template with four whole parameters. we love a customizable icon 💖

🌸 NAME 🌸

std::istream_iterator< _Tp, _CharT, _Traits, _Dist > — ngl, it "provides input iterator semantics for streams." that's the whole job. that's the moment. periodt.

🦋 SYNOPSIS 🦋

#include <iterator>

and it inherits from:

std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >

like, it's giving nepo baby but in a cute inheritance way 🎀

👑 Public Types 👑

  • typedef _CharT char_type — the character type, no notes.
  • typedef _Distance difference_type — lowkey the "distance between iterators" rep, like the space between two vibes.
  • typedef basic_istream< _CharT, _Traits > istream_type — the stream type it rolls with.
  • typedef _Category iterator_category — one of the tag types, iykyk.
  • typedef _Pointer pointer — this one "represents a pointer-to-value_type," which is exactly what it sounds like.
  • typedef _Reference reference — and this is the "reference-to-value_type" one. slay.
  • typedef _Traits traits_type — traits, the personality of your characters.
  • typedef _Tp value_type — the type "pointed to" by the iterator. main character type energy fr fr.

💅 Public Member Functions 💅

  • constexpr istream_iterator () noexcept(/*conditional */) — constructs the end of input stream iterator. this is your "we're done here" energy 💀
  • constexpr istream_iterator (const istream_iterator &__obj) noexcept(/*conditional */) — the copy constructor, quietly doing its thing.
  • istream_iterator (istream_type &__s) — constructs the start of input stream iterator. your "let's gooo" moment 🔥
  • const _Tp & operator* () const noexcept — dereference, as one does.
  • istream_iterator & operator++ () — prefix increment, the classic.
  • istream_iterator operator++ (int) — postfix increment, the one with the int that nobody uses for anything.
  • const _Tp * operator-> () const noexcept — arrow operator, pointing at things, very demure.
  • istream_iterator & operator= (const istream_iterator &)=default — assignment, defaulted, no drama.

🫶 Friends 🫶

  • bool operator== (const istream_iterator &__x, const istream_iterator &__y) noexcept — returns true if the iterators refer to the same stream, or are both at end-of-stream. honestly iconic behavior.

🧚 Detailed Description 🧚

here's the full template signature because bestie you need the receipts:

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

and its whole personality is: "Provides input iterator semantics for streams." that's it. that's the thesis. 💜

🌈 Member Typedef Documentation 🌈

okay so these are all <italic>[inherited]</italic> from std::iterator, and they all share the same template preamble, so let me give it to you once:

template<typename _Category , typename _Tp , typename _Distance  =
    ptrdiff_t, typename _Pointer  = _Tp*, typename _Reference  = _Tp&>

now, the actual typedefs, one by one, because we don't skip ✨

  • typedef _Distance std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::difference_type [inherited] — "Distance between iterators is represented as this type." yes, exact words, we don't editorialize the facts.
  • typedef _Category std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::iterator_category [inherited] — "One of the tag types." queen of being one of the tag types.
  • typedef _Pointer std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::pointer [inherited] — "This type represents a pointer-to-value_type."
  • typedef _Reference std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::reference [inherited] — "This type represents a reference-to-value_type."
  • typedef _Tp std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::value_type [inherited] — "The type 'pointed to' by the iterator."

💖 Constructor & Destructor Documentation 💖

same deal, the template preamble is:

template<typename _Tp , typename _CharT  = char, typename _Traits  =
    char_traits<_CharT>, typename _Dist  = ptrdiff_t>
  • std::istream_iterator< _Tp, _CharT, _Traits, _Dist >::istream_iterator () — tags: [inline], [constexpr], [noexcept]. constructs the end of input stream iterator. your "i'm done scrolling" iterator 🛑
  • std::istream_iterator< _Tp, _CharT, _Traits, _Dist >::istream_iterator (istream_type & __s) — tag: [inline]. constructs the start of input stream iterator from a stream reference. go get 'em 🏁
  • bool operator== (const istream_iterator< _Tp, _CharT, _Traits, _Dist > & __x, const istream_iterator< _Tp, _CharT, _Traits, _Dist > & __y) — tag: [friend]. returns true if the iterators refer to the same stream, or are both at end-of-stream. friendship ended with everything else, now operator== is my best friend 🫶

🎀 Author 🎀

"Generated automatically by Doxygen for libstdc++ from the source code." — so nobody hand-wrote this, it's a robot flexing. respect tho. 🤖

ngl this whole page is auto-generated docs energy, but it's our auto-generated docs energy. no cap. 💀

and that's the tea ☕ — brought to you by libstdc++, generated by Doxygen straight from the source code, under the 3cxx section banner. mwah 💋 ✨🌸💖

📦 where this page comes from