__gnu_debug::_Safe_sequence_base(3cxx)

💖 NAME 💖

Okay bestie, this is the __gnu_debug::_Safe_sequence_base(3cxx) page from the libstdc++ manual. It's the base class that supports tracking of iterators that reference a sequence. Lowkey iconic infrastructure. 💅

✨ SYNOPSIS ✨

#include <safe_base.h>

Inherited by __gnu_debug::_Safe_sequence< _SafeSequence >, __gnu_debug::_Safe_sequence< _Sequence >, and __gnu_debug::_Safe_unordered_container_base.

🌸 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 ever. No cap. 🚨

🎀 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 ()
• void _M_detach_all ()
• void _M_detach_singular ()
• __gnu_cxx::__mutex & _M_get_mutex () throw ()
• void _M_invalidate_all () const
• void _M_revalidate_singular ()
• void _M_swap (_Safe_sequence_base &__x) 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 derive 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. It's giving iterator surveillance system, honestly. 👀

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. Bestie, this is serious: no throwing allowed here, periodt. 😭

🧚 Constructor & Destructor Documentation 🧚

constexpr __gnu_debug::_Safe_sequence_base::~_Safe_sequence_base ()

Tags: [inline], [constexpr], [protected].

Notify all iterators that reference this sequence that the sequence is being destroyed.

References _M_detach_all().

💜 Member Function Documentation 💜

void __gnu_debug::_Safe_sequence_base::_M_detach_all ()

Tag: [protected].

Detach all iterators, leaving them singular.

Referenced by ~_Safe_sequence_base().

void __gnu_debug::_Safe_sequence_base::_M_detach_singular ()

Tag: [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 ()

Tag: [protected].

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

Tags: [inline], [protected].

Invalidates all iterators.

References _M_version.

void __gnu_debug::_Safe_sequence_base::_M_revalidate_singular ()

Tag: [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).

void __gnu_debug::_Safe_sequence_base::_M_swap (_Safe_sequence_base & __x)

Tags: [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. Cute little iterator custody swap. 🫶

🍓 Member Data Documentation 🍓

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_const_iterators

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

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

Tag: [mutable].

The container version number. This number may never be 0.

Referenced by _M_invalidate_all(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator=(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator=(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator=(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator=().

And yes, bestie, the _Safe_iterator and _Safe_local_iterator operator=() refs show up twice in the original — I'm keeping both, no erasing, periodt. 💀

🌈 Author 🌈

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

---

Byeee 🫶💜 — source/version vibes: libstdc++ docs, 3cxx section; date: not present on this page, so no made-up date, bestie. Slay and stay safe 💅✨