STD::OSTREAM_ITERATOR(3)

🌸 NAME 🌸

std::ostream_iterator< _Tp, _CharT, _Traits > — bestie, this is the little guy that gives you output iterator semantics for streams 💖 (it's a (3) manual page, library functions manual, if you were wondering where you wandered into)

---

✨ SYNOPSIS ✨

#include <iterator>

It inherits std::iterator< output_iterator_tag, void, void, void, void >.

🎀 Public Types 🎀

• typedef output_iterator_tag iterator_category — one of the tag types 🏷️
• typedef void pointer — this type represents a pointer-to-value_type
• typedef void reference — this type represents a reference-to-value_type
• typedef void value_type — the type "pointed to" by the iterator
  • using difference_type — public typedef, that's it, that's the whole vibe
• typedef _CharT char_type — public typedef
• typedef _Traits traits_type — public typedef
• typedef basic_ostream< _CharT, _Traits > ostream_type — public typedef

🦋 Public Member Functions 🦋

• ostream_iterator (const ostream_iterator &__obj) noexcept — copy constructor 💅
• ostream_iterator (ostream_type &__s) noexcept — construct from an ostream
• ostream_iterator (ostream_type &__s, const _CharT *__c) noexcept
• ostream_iterator & operator* () noexcept
• ostream_iterator & operator++ () noexcept
• ostream_iterator & operator++ (int) noexcept
• ostream_iterator & operator= (const _Tp &__value) — writes value to the underlying ostream using operator<<. If it was constructed with a delimiter string, it writes the delimiter to the ostream too ✍️
• ostream_iterator & operator= (const ostream_iterator &)=default

---

👑 Detailed Description 👑

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
class std::ostream_iterator< _Tp, _CharT, _Traits >"Provides output
    iterator semantics for streams.

No cap, this class hands you an iterator that writes to an ostream 🫶 The type Tp is the only type written by this iterator, and there must be an operator<<(Tp) defined. Periodt.

🌈 Template Parameters 🌈

• _Tp — the type to write to the ostream.
• _CharT — the ostream char_type.
• _Traits — the ostream char_traits.

---

💜 Member Typedef Documentation 💜

char_type

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
typedef _CharT std::ostream_iterator< _Tp, _CharT, _Traits >::char_type

Public typedef, iconic behavior 💫

difference_type

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
using std::ostream_iterator< _Tp, _CharT, _Traits >::difference_type

Public typedef ✨

iterator_category (inherited)

typedef output_iterator_tag std::iterator< output_iterator_tag, void, void,
    void, void >::iterator_category [inherited]

One of the tag types 🏷️

ostream_type

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
typedef basic_ostream<_CharT, _Traits>
    std::ostream_iterator< _Tp, _CharT, _Traits >::ostream_type

Public typedef 🌸

pointer (inherited)

typedef void std::iterator< output_iterator_tag, void, void, void, void
    >::pointer [inherited]

This type represents a pointer-to-value_type.

reference (inherited)

typedef void std::iterator< output_iterator_tag, void, void, void, void
    >::reference [inherited]

This type represents a reference-to-value_type.

traits_type

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
typedef _Traits std::ostream_iterator< _Tp, _CharT, _Traits >::traits_type

Public typedef 💖

value_type (inherited)

typedef void std::iterator< output_iterator_tag, void, void, void, void
    >::value_type [inherited]

The type "pointed to" by the iterator 👀

---

🧚 Constructor & Destructor Documentation 🧚

ostream_iterator (ostream_type & __s) — from an ostream

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
std::ostream_iterator< _Tp, _CharT, _Traits >::ostream_iterator (ostream_type
    & __s) [inline], [noexcept]

Construct from an ostream 🌊

References std::__addressof().

Referenced by ostream_iterator().

ostream_iterator (ostream_type & __s, const _CharT * __c) — from an ostream + delimiter

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
std::ostream_iterator< _Tp, _CharT, _Traits >::ostream_iterator (ostream_type
    & __s, const _CharT * __c) [inline], [noexcept]

Construct from an ostream.

The delimiter string c is written to the stream after every Tp written to the stream. The delimiter is not copied, and thus must not be destroyed while this iterator is in use ⚠️

Parameters

• __s — underlying ostream to write to.
• __c — CharT delimiter string to insert.

References std::__addressof().

ostream_iterator (const ostream_iterator< _Tp, _CharT, _Traits > & __obj) — copy constructor

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
std::ostream_iterator< _Tp, _CharT, _Traits >::ostream_iterator (const
    ostream_iterator< _Tp, _CharT, _Traits > & __obj) [inline], [noexcept]

Copy constructor 🫶

References ostream_iterator().

---

🍓 Member Function Documentation 🍓

operator= (const _Tp & __value)

template<typename _Tp, typename _CharT = char, typename _Traits =
    char_traits<_CharT>>
ostream_iterator & std::ostream_iterator< _Tp, _CharT, _Traits >::operator=
    (const _Tp & __value) [inline]

Writes value to the underlying ostream using operator<<. If it was constructed with a delimiter string, writes the delimiter to the ostream too. Slay 💅

---

⭐ Author ⭐

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

---

okay bestie that's the whole page 💖 that was libstdc++, std::ostre..., _Traits >(3), and yes the title got cut off by the page header, we don't talk about it 🙈 go write some iterators, you've got this 👑✨