STD::INSERT_ITERATOR(3)

💖 std::insert_iterator< _Container >(3) 💖

okay bestie, you found the std::insert_iterator< _Container >(3) page — it lives in the Library Functions Manual, and it's the one that turns your boring little assignment into a whole insertion moment. no cap. 🦋

---

🌸 NAME 🌸

std::insert_iterator< _Container > — turns assignment into insertion. that's it, that's the whole personality. 💅

---

✨ SYNOPSIS ✨

#include <iterator>

inherits std::iterator< output_iterator_tag, void, void, void, void > 👑

🎀 Public Types 🎀

• typedef _Container container_type — a nested typedef for the type of whatever container you used. yes, whatever container, she's flexible like that.
• using difference_type — that's it, that's the whole line, bestie. 🙈
• typedef output_iterator_tag iterator_category — one of the tag types. iconic little label.
• 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.

💜 Public Member Functions 💜

• constexpr insert_iterator (_Container &__x, _Iter __i) — the constructor, she's constexpr, she's lowkey everything.
• constexpr insert_iterator & operator* () — simply returns *this. no thoughts, just vibes.
• constexpr insert_iterator & operator++ () — simply returns *this. (this iterator does not move.) periodt.
• constexpr insert_iterator & operator++ (int) — simply returns *this. (this iterator does not move.) still not moving, bestie.
• constexpr insert_iterator & operator= (const typename _Container::value_type &__value) — the main character. assignment that inserts. more below ⬇️
• constexpr insert_iterator & operator= (typename _Container::value_type &&__value) — the rvalue-flavored twin. also slay.

🌈 Protected Attributes 🌈

• _Container * container — your container, held close.
• _Iter iter — your position, held closer.

---

🧚 Detailed Description 🧚

template<typename _Container>
    class std::insert_iterator< _Container >

Turns assignment into insertion.

these are output iterators, constructed from a container-of-T. assigning a T to the iterator inserts it in the container at the iterator's position, rather than overwriting the value at that position. so rude of overwriting, honestly. 💀

(sequences will actually insert a copy of the value before the iterator's position. important detail, don't skip it.)

Tip: using the inserter function to create these iterators can save typing. 🫶

---

⭐ Member Typedef Documentation ⭐

template<typename _Container> typedef _Container std::insert_iterator< _Container >::container_type

a nested typedef for the type of whatever container you used.

---

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

one of the tag types.

---

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

this type represents a pointer-to-value_type.

---

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

this type represents a reference-to-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 🎀

template<typename _Container> std::insert_iterator< _Container >::insert_iterator (_Container & __x, _Iter __i) [inline], [constexpr]

the only way to create this iterator is with a container and an initial position (a normal iterator into the container). no shortcuts, no secret menu, this is the way. ✨

references std::__addressof().

---

💅 Member Function Documentation 💅

template<typename _Container> insert_iterator & std::insert_iterator< _Container >::operator* () [inline], [nodiscard], [constexpr]

simply returns *this.

---

template<typename _Container> insert_iterator & std::insert_iterator< _Container >::operator++ () [inline], [constexpr]

simply returns *this. (this iterator does not move.). 😭

---

template<typename _Container> insert_iterator & std::insert_iterator< _Container >::operator++ (int ) [inline], [constexpr]

simply returns *this. (this iterator does not move.). yes, again. she said what she said.

---

template<typename _Container> insert_iterator & std::insert_iterator< _Container >::operator= (const typename _Container::value_type & __value) [inline], [constexpr]

Parameters

• __value — an instance of whatever type container_type::const_reference is; presumably a reference-to-const T for container<T>.

Returns

• this iterator, for chained operations.

this kind of iterator maintains its own position in the container. assigning a value to the iterator will insert the value into the container at the place before the iterator.

the position is maintained such that subsequent assignments will insert values immediately after one another. for example,

// vector v contains A and Z

insert_iterator i (v, ++v.begin());
i = 1;
i = 2;
i = 3;

// vector v contains A, 1, 2, 3, and Z

look at that glow-up. A and Z were just vibing and now the whole friend group is there. 🍓

---

👑 Author 👑

generated automatically by Doxygen for libstdc++ from the source code. it didn't even have to try. 💖

---

and that's the whole page, bestie — footer credits libstdc++ with the std::inser...ontainer >(3) title holding it down at the bottom. now go insert something before your iterator's position. iykyk. 🌈🦋✨