STD::OSTREAM_ITERATOR(3cxx)

💖 NAME 💖

okay so this is the std::ostream_iterator< _Tp, _CharT, _Traits > page, manual section 3cxx — yes the header is a little truncated, but she's still iconic. 💅

std::ostream_iterator< _Tp, _CharT, _Traits > — Provides output iterator semantics for streams. ✨

✨ SYNOPSIS ✨

#include <iterator>

Inherits std::iterator< output_iterator_tag, void, void, void, void >. that's the whole synopsis vibe, bestie. 🦋

🌸 Public Types 🌸

• iterator_category — typedef output_iterator_tag iterator_category; one of the tag types.
• pointer — typedef void pointer; this type represents a pointer-to-value_type.
• reference — typedef void reference; this type represents a reference-to-value_type.
• value_type — typedef void value_type; the type 'pointed to' by the iterator.
• difference_type — using difference_type = ptrdiff_t; public typedef.
• char_type — typedef _CharT char_type; public typedef.
• traits_type — typedef _Traits traits_type; public typedef.
• ostream_type — 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 — Construct from an ostream.
• ostream_iterator & operator* () noexcept — listed on the page, no extra description.
• ostream_iterator & operator++ () noexcept — listed on the page, no extra description.
• ostream_iterator & operator++ (int) noexcept — listed on the page, no extra description.
• ostream_iterator & operator= (const _Tp &__value) — Writes value to underlying ostream using operator<<. If constructed with delimiter string, writes delimiter to ostream.
• ostream_iterator & operator= (const ostream_iterator &)=default — listed as =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. periodt. 💖

This class provides an iterator to write to an ostream. The type Tp is the only type written by this iterator and there must be an operator<<(Tp) defined.

🌟 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. ✨

difference_type

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

Public typedef. 💖

iterator_category

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

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

This type represents a pointer-to-value_type. 🌸

reference

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

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) [inline], [noexcept]

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. 💅

ostream_iterator (ostream_type & __s, const _CharT * __c) [inline], [noexcept]

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. bestie, that's a real "do not let it die while in use" warning, no cap. 😭

Parameters

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

ostream_iterator (const ostream_iterator< _Tp, _CharT, _Traits > & __obj) [inline], [noexcept]

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. 🫶

🌈 Member Function Documentation 🌈

operator=

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 underlying ostream using operator<<. If constructed with delimiter string, writes delimiter to ostream. 💖

👑 Author 👑

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

---

k bye bestie! 🫶 The footer's source/version tag is libstdstd::ostream_i...harT, _Traits >(3cxx); date on this original page: not shown, so no invented date energy here. 💜