__gnu_debu...uence_base(3)

💖 __gnu_debug::_Safe_sequence_base — from the Library Functions Manual 🎀

okay bestie, sit down, grab a boba, because we're about to talk about the ✨base class✨ that makes sure your iterators don't betray you. no cap. this one lives in the libstdc++ manual, section 3, and it's literally the foundation underneath all the safe containers. it's giving "quiet kid in the back of the class who is actually running the whole group project." 💅

---

🌸 NAME 🌸

__gnu_debug::_Safe_sequence_base — the base class that supports tracking of iterators that reference a sequence.

---

✨ SYNOPSIS ✨

#include <safe_base.h>

🦋 Inherited by

Inherited by __gnu_debug::_Safe_sequence< _SafeSequence >,
__gnu_debug::_Safe_sequence< basic_string< _CharT, std::char_traits<
_CharT >, std::allocator< _CharT > > >, __gnu_debug::_Safe_sequence<
deque< _Tp, std::allocator< _Tp > > >, __gnu_debug::_Safe_sequence<
_SafeContainer >, __gnu_debug::_Safe_sequence< list< _Tp,
std::allocator< _Tp > > >, __gnu_debug::_Safe_sequence< map< _Key, _Tp,
std::less< _Key >, std::allocator< std::pair< const _Key, _Tp > > > >,
__gnu_debug::_Safe_sequence< multimap< _Key, _Tp, std::less< _Key >,
std::allocator< std::pair< const _Key, _Tp > > > >,
__gnu_debug::_Safe_sequence< multiset< _Key, std::less< _Key >,
std::allocator< _Key > > >, __gnu_debug::_Safe_sequence< set< _Key,
std::less< _Key >, std::allocator< _Key > > >,
__gnu_debug::_Safe_sequence< vector< _Tp, std::allocator< _Tp > > >,
__gnu_debug::_Safe_sequence< _Sequence >, and
__gnu_debug::_Safe_unordered_container_base.

look at that family tree 😭 it's a whole dynasty.

👑 Public Attributes

• _Safe_iterator_base * _M_const_iterators — the list of constant iterators that reference this container. const girlies, assemble 🫶
• _Safe_iterator_base * _M_iterators — the list of mutable iterators that reference this container. the ones who are allowed to change things, main character energy fr fr
• unsigned int _M_version — the container version number. This number may never be 0. not ever. zero is forbidden. 🚫

🧚 Protected Member Functions

• constexpr _Safe_sequence_base (_Safe_sequence_base &&__seq) noexcept
• constexpr _Safe_sequence_base (const _Safe_sequence_base &) noexcept
• constexpr ~_Safe_sequence_base () noexcept
• 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
• constexpr _Safe_sequence_base & operator= (_Safe_sequence_base &&__x) noexcept
• constexpr _Safe_sequence_base & operator= (const _Safe_sequence_base &) noexcept

🌈 Friends

• class _Safe_iterator_base

---

💜 Detailed Description 💜

Base class that supports tracking of iterators that reference a sequence.

The _Safe_sequence_base class provides basic support for tracking iterators into a sequence. Sequences that track iterators must derived from _Safe_sequence_base publicly, so that safe iterators (which inherit _Safe_iterator_base) can attach to them. This class contains two linked lists of iterators, one for constant iterators and one for mutable iterators, and a version number that allows very fast invalidation of all iterators that reference the container.

⚠️ okay this next bit is IMPORTANT, do not skip: This class must ensure that no operation on it may throw an exception, otherwise safe sequences may fail to provide the exception-safety guarantees required by the C++ standard. like, that's the whole assignment. no throwing. not even a little. 🚨

---

🎀 Constructor & Destructor Documentation 🎀

💅 __gnu_debug::_Safe_sequence_base::~_Safe_sequence_base () [inline], [constexpr], [protected], [noexcept]

Notify all iterators that reference this sequence that the sequence is being destroyed. it's a goodbye tour, and every iterator gets a text. 🥲

References _M_detach_all().

---

🌟 Member Function Documentation 🌟

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

Detach all iterators, leaving them singular.

Referenced by ~_Safe_sequence_base().

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

Detach all singular iterators.

Postcondition

for all iterators i attached to this sequence, i->_M_version == _M_version.

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

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]

Invalidates all iterators. all of them. every single one. 💀

References _M_invalidate_all(), and _M_version.

Referenced by _M_invalidate_all().

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

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 the glow-up arc for iterators that got cancelled earlier. ✨

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

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. it's a trade, bestie — everything moves, nobody gets left behind. 🔄

---

🍓 Member Data Documentation 🍓

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

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]

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]

The container version number. This number may never be 0. (saying it twice because it MATTERS 💅)

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.

---

okay that's the whole page, you ate it, periodt 💖 this was __gnu_debug::_Safe_sequence_base(3) from the libstdc++ manual — auto-generated by Doxygen for libstdc++ straight from the source code, so if you ever need to cite it, that's the vibe. mwah, go write some safe iterators 🫶🌸