STD::FRONT_INSERT_ITERATOR(3)

💖 std::front_insert_iterator< _Container > — from the Library Functions Manual (section 3) 💖

okay bestie, sit down, hydrate, and let me tell you about the iterator that just inserts at the front like it owns the place 👑

---

✨ NAME ✨

std::front_insert_iterator< _Container > — turns assignment into insertion. that's it, that's the whole job, and she does it flawlessly 💅

---

🌸 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.
• using difference_type — yep, she's there.
• 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.

---

💜 Public Member Functions 💜

• constexpr front_insert_iterator (_Container &__x) — the only way to create this iterator is with a container. no container, no iterator, no exceptions.
• constexpr front_insert_iterator & operator* () — simply returns *this.
• constexpr front_insert_iterator & operator++ () — simply returns *this. (this iterator does not move.) 😭 iconic behaviour honestly
• constexpr front_insert_iterator operator++ (int) — simply returns *this. (this iterator does not move.) still not moving. still slaying.
• constexpr front_insert_iterator & operator= (const typename _Container::value_type &__value)
• constexpr front_insert_iterator & operator= (typename _Container::value_type &&__value)

---

🌈 Protected Attributes 🌈

• _Container * container

---

🦋 Detailed Description 🦋

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

Turns assignment into insertion.

These are output iterators, constructed from a container-of-T. Assigning a T to the iterator prepends it to the container using push_front. 🫶

Tip: using the front_inserter function to create these iterators can save typing. your fingers will thank you.

---

⭐ Member Typedef Documentation ⭐

template<typename _Container>
    typedef _Container std::front_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::front_insert_iterator< _Container >::front_insert_iterator (_Container & __x)
    [inline], [explicit], [constexpr]

The only way to create this iterator is with a container.

References std::__addressof().

---

🔥 Member Function Documentation 🔥

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

Simply returns *this.

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

Simply returns *this. (This iterator does not move.)

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

Simply returns *this. (This iterator does not move.)

template<typename _Container>
    front_insert_iterator &
    std::front_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. chain her up, she's ready 🫶

This kind of iterator doesn't really have a position in the container (you can think of the position as being permanently at the front, if you like). Assigning a value to the iterator will always prepend the value to the front of the container. main character energy: always first, never moves. periodt. 💅✨

---

👑 Author 👑

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

---

okay that's the whole vibe check, bestie 💖 this page is part of the libstdc++ manual, section 3 (Library Functions Manual), and it was generated for that libstdc++ source — mwah, go forth and push_front responsibly 🎀🦋🌸