__GNU_DEBUG::_SAFE_UNORDERED_CONTAINER(3)

Hey bestie! Welcome to the Library Functions Manual page for __gnu_debug::_Safe_unordered_container< _Container >(3). This is the safe unordered container base class, and she is iconic. Let's get into it. 💖

---

✨ NAME ✨

__gnu_debug::_Safe_unordered_container< _Container > — Base class for constructing a safe unordered container type that tracks iterators that reference it.

---

🦋 SYNOPSIS 🦋

#include <safe_unordered_container.h>

Inherits __gnu_debug::_Safe_unordered_container_base.

Inherited by these absolute legends:

• __gnu_debug::_Safe_container< unordered_map, _Alloc, __gnu_debug::_Safe_unordered_container >
• __gnu_debug::_Safe_container< unordered_multimap, _Alloc, __gnu_debug::_Safe_unordered_container >
• __gnu_debug::_Safe_container< unordered_set, _Alloc, __gnu_debug::_Safe_unordered_container >
• __gnu_debug::_Safe_container< unordered_multiset, _Alloc, __gnu_debug::_Safe_unordered_container >

🌸 Public Attributes 🌸

• _Safe_iterator_base * _M_const_iterators — The list of constant iterators that reference this container.
• _Safe_iterator_base * _M_const_local_iterators — The list of constant local iterators that reference this container.
• _Safe_iterator_base * _M_iterators — The list of mutable iterators that reference this container.
• _Safe_iterator_base * _M_local_iterators — The list of mutable local iterators that reference this container.
• unsigned int _M_version — The container version number. This number may never be 0.

🎀 Protected Member Functions 🎀

• void _M_detach_all () const
• void _M_detach_singular () const
• __gnu_cxx::__mutex & _M_get_mutex () const noexcept
• template<typename _VictimIt> void _M_invalidate (_VictimIt __victim)
• template<typename _VictimIt> void _M_invalidate (_VictimIt __victim, const __gnu_cxx::__scoped_lock &__lock)
• constexpr void _M_invalidate_all () const
• void _M_invalidate_all ()
• template<typename _Predicate> void _M_invalidate_all_if (_Predicate __pred)
• void _M_revalidate_singular () const
• void _M_swap (const _Safe_sequence_base &__x) const noexcept
• void _M_swap (const _Safe_unordered_container_base &__x) const noexcept

---

💖 Detailed Description 💖

template<typename _Container> class __gnu_debug::_Safe_unordered_container< _Container > — Base class for constructing a safe unordered container type that tracks iterators that reference it.

Okay so the class template _Safe_unordered_container makes building safe unordered containers so much easier. It keeps tabs on the iterators that reference the container, so those iterators get notified whenever the container changes in a way that could affect their operation — for example, if the container invalidates its iterators or gets destructed. Obsessed with the safety.

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. The derived class must have iterator and const_iterator types that are instantiations of class template _Safe_iterator for this container, and local_iterator and const_local_iterator types that are instantiations of class template _Safe_local_iterator for this container. After that? Iterators get tracked automatically. Periodt. ✨

---

🧚 Member Function Documentation 🧚

void __gnu_debug::_Safe_unordered_container_base::_M_detach_all () const

[protected], [inherited]

Detach all iterators, leaving them singular.

Referenced by ~_Safe_unordered_container_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.

__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.

References _M_invalidate_all(), and _M_version.

Referenced by _M_invalidate_all().

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).

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.

void __gnu_debug::_Safe_unordered_container_base::_M_swap (const _Safe_unordered_container_base & __x) const

[protected], [noexcept], [inherited]

Swap this container with the given container. 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.

---

🌈 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_unordered_container_base::_M_const_local_iterators

[mutable], [inherited]

The list of constant local iterators that reference this container.

_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().

_Safe_iterator_base* __gnu_debug::_Safe_unordered_container_base::_M_local_iterators

[mutable], [inherited]

The list of mutable local iterators that reference this container.

unsigned int __gnu_debug::_Safe_sequence_base::_M_version

[mutable], [inherited]

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

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 bestie, that's the whole page! Signed off by libstdc++ and titled __gnu_debug::_Safe_unordered_container< _Container >(3). No date on this footer, just pure libstdc++ energy. Stay safe, stay tracked! 💅🦋