__GNU_DEBUG::_SAFE_SEQUENCE(3)

💖 NAME 💖

__gnu_debug::_Safe_sequence< _Sequence > — bestie, this is the base class for constructing a safe sequence type that tracks iterators that reference it. periodt. ✨

(Oh and real quick — this page lives in the Library Functions Manual, section 3. iykyk 🫶)

---

🌸 SYNOPSIS 🌸

#include <safe_sequence.h>

• Inherits __gnu_debug::_Safe_sequence_base. yes, it's a nepo baby, it inherited everything 💅
• Inherited by __gnu_debug::_Safe_container< deque, _Allocator, __gnu_debug::_Safe_sequence >, __gnu_debug::_Safe_container< basic_string, _Allocator, _Safe_sequence, bool(1)>, __gnu_debug::_Safe_container< vector, _Allocator, __gnu_debug::_Safe_sequence >, and __gnu_debug::_Safe_node_sequence< _Sequence >. the whole friend group fr fr 🎀

✨ Public Member Functions ✨

• template<typename _Predicate> constexpr void _M_invalidate_if (_Predicate __pred) const
• template<typename _Predicate> void _M_transfer_from_if (const _Safe_sequence &__from, _Predicate __pred) const

🦋 Public Attributes 🦋

• _Safe_iterator_base * _M_const_iterators — The list of constant iterators that reference this container.
• _Safe_iterator_base * _M_iterators — The list of mutable iterators that reference this container.
• unsigned int _M_version — The container version number. This number may never be 0. not even once. 🚫

💜 Protected Member Functions 💜

• void _M_detach_all () const
• void _M_detach_singular () const
• __gnu_cxx::__mutex & _M_get_mutex () const noexcept
• constexpr void _M_invalidate_all () const
• void _M_revalidate_singular () const
• void _M_swap (const _Safe_sequence_base &__x) const noexcept

---

🌈 Detailed Description 🌈

template<typename _Sequence>
    class __gnu_debug::_Safe_sequence< _Sequence >

Base class for constructing a safe sequence type that tracks iterators that reference it. 🫶

okay so the tea is this: the class template _Safe_sequence simplifies the construction of safe sequences that track the iterators that reference the sequence, so that those iterators get notified of changes in the sequence that may affect their operation — e.g., if the container invalidates its iterators or is destructed. no cap, it's giving extremely attentive bestie energy. 💅

the way this works: this class template may only be used by deriving from it and passing the name of the derived class as its template parameter via the curiously recurring template pattern. (iconic name, iconic behaviour ✨)

and the derived class must have iterator and const_iterator types that are instantiations of class template _Safe_iterator for this sequence. do that, and the iterators will then be tracked automatically. slay, no manual labour required. 🧚

---

👑 Member Function Documentation 👑

void __gnu_debug::_Safe_sequence_base::_M_detach_all () const [protected], [inherited]

Detach all iterators, leaving them singular. bye besties, you're on your own now 😭

Referenced by ~_Safe_sequence_base().

void __gnu_debug::_Safe_sequence_base::_M_detach_singular () const [protected], [inherited]

Detach all singular iterators.

Postcondition: for all iterators i attached to this sequence, i->_M_version == _M_version. consistency queen 👑

__gnu_cxx::__mutex & __gnu_debug::_Safe_sequence_base::_M_get_mutex () const [protected], [noexcept], [inherited]

For use in _Safe_sequence.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

void __gnu_debug::_Safe_sequence_base::_M_invalidate_all () const [inline], [constexpr], [protected], [inherited]

Invalidates all iterators. every single one. the whole roster. 💀

References _M_invalidate_all(), and _M_version.

Referenced by _M_invalidate_all().

template<typename _Sequence> template<typename _Predicate> void __gnu_debug::_Safe_sequence< _Sequence >::_M_invalidate_if (_Predicate __pred) const [inline], [constexpr]

Invalidates all iterators x that reference this sequence, are not singular, and for which __pred(x) returns true. __pred will be invoked with the normal iterators nested in the safe ones. so it's a vibe check, but for iterators 🔥

void __gnu_debug::_Safe_sequence_base::_M_revalidate_singular () const [protected], [inherited]

Revalidates all attached singular iterators. This method may be used to validate iterators that were invalidated before (but for some reason, such as an exception, need to become valid again). it's giving second-chance romance 🥹

void __gnu_debug::_Safe_sequence_base::_M_swap (const _Safe_sequence_base & __x) const [protected], [noexcept], [inherited]

Swap this sequence with the given sequence. This operation also swaps ownership of the iterators, so that when the operation is complete all iterators that originally referenced one container now reference the other container. full custody swap, no drama 💅

template<typename _Sequence> template<typename _Predicate> void __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if (const _Safe_sequence< _Sequence > & __from, _Predicate __pred) const

Transfers all iterators x that reference from sequence, are not singular, and for which __pred(x) returns true. __pred will be invoked with the normal iterators nested in the safe ones.

References std::__addressof(), __gnu_debug::_Safe_sequence_base::_M_const_iterators, __gnu_debug::_Safe_sequence_base::_M_get_mutex(), __gnu_debug::_Safe_sequence_base::_M_iterators, __gnu_debug::_Safe_iterator_base::_M_next, __gnu_debug::_Safe_iterator_base::_M_prior, __gnu_debug::_Safe_iterator_base::_M_sequence, __gnu_debug::_Safe_iterator_base::_M_version, and __gnu_debug::_Safe_sequence_base::_M_version.

---

🍓 Member Data Documentation 🍓

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_const_iterators [mutable], [inherited]

The list of constant iterators that reference this container. 💖

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_iterators [mutable], [inherited]

The list of mutable iterators that reference this container.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

unsigned int __gnu_debug::_Safe_sequence_base::_M_version [mutable], [inherited]

The container version number. This number may never be 0. genuinely never. zero is not invited to this party 🙈

Referenced by _M_invalidate_all(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=().

---

🧚 Author 🧚

Generated automatically by Doxygen for libstdc++ from the source code. no human wrote this, it just manifested ✨

---

🫶 ok that's the whole page bestie, every single flag, member, mutex and version number accounted for, nothing skipped, nothing invented. ate and left no crumbs. 💅

made with love for libstdc++, page __gnu_debug::_Safe_sequence< _Sequence >(3) from the Library Functions Manual — mwah, go track some iterators 🎀