__gnu_debu...rator_base(3)

📦
version 16.2.1+r23+gd564253eb6c8 · 9 versions
, in arch rolling, fedora 44

💅 __gnu_debu...rator_base(3) 💅

okay so bestie, we're in the Library Functions Manual and this page is literally the blueprint. it's giving foundational. it's giving "everything else is built on me". let's get into it 🫶

✨ NAME ✨

__gnu_debug::_Safe_local_iterator_base — the basic functionality for a safe iterator.

🌸 SYNOPSIS 🌸

#include <safe_unordered_base.h>

Inherits __gnu_debug::_Safe_iterator_base.

Inherited by a whole army of safe local iterators, no cap:

  • __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >
  • __gnu_debug::_Safe_local_iterator< _Base_local_iterator, unordered_map >
  • __gnu_debug::_Safe_local_iterator< _Base_const_local_iterator, unordered_map >
  • __gnu_debug::_Safe_local_iterator< _Base_local_iterator, unordered_multimap >
  • __gnu_debug::_Safe_local_iterator< _Base_const_local_iterator, unordered_multimap >
  • __gnu_debug::_Safe_local_iterator< _Base_local_iterator, unordered_set >
  • __gnu_debug::_Safe_local_iterator< _Base_const_local_iterator, unordered_set >
  • __gnu_debug::_Safe_local_iterator< _Base_local_iterator, unordered_multiset >
  • __gnu_debug::_Safe_local_iterator< _Base_const_local_iterator, unordered_multiset >
  • and __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >

👑 Public Member Functions 👑

  • bool _M_attached_to (const _Safe_sequence_base *__seq) const
  • bool _M_can_compare (const _Safe_iterator_base &__x) const noexcept
  • void _M_invalidate ()
  • void _M_reset () noexcept
  • const _Safe_unordered_container_base * _M_safe_container () const noexcept
  • bool _M_singular () const noexcept
  • void _M_unlink () noexcept

🎀 Public Attributes 🎀

  • _Safe_iterator_base * _M_next
  • _Safe_iterator_base * _M_prior
  • const _Safe_sequence_base * _M_sequence
  • unsigned int _M_version

🦋 Protected Member Functions 🦋

  • _Safe_local_iterator_base ()
  • _Safe_local_iterator_base (const _Safe_local_iterator_base &__x, bool __constant)
  • _Safe_local_iterator_base (const _Safe_unordered_container_base *__seq, bool __constant)
  • void _M_attach (const _Safe_sequence_base *__seq, bool __constant)
  • void _M_attach (const _Safe_unordered_container_base *__cont, bool __constant)
  • void _M_attach_single (const _Safe_sequence_base *__seq, bool __constant) noexcept
  • void _M_attach_single (const _Safe_unordered_container_base *__cont, bool __constant) noexcept
  • void _M_detach ()
  • void _M_detach_single () noexcept
  • __gnu_cxx::__mutex & _M_get_mutex () noexcept

🌈 Detailed Description 🌈

basic functionality for a safe iterator. that's the whole vibe. ✨

the _Safe_local_iterator_base base class implements the functionality of a safe local iterator that is not specific to a particular iterator type. it's the general-purpose backbone, fr fr. it contains:

  • a pointer back to the container it references, plus
  • iterator version information, plus
  • pointers that form a doubly-linked list of local iterators referenced by the container.
🚨 BIG RULE, DO NOT BREAK IT: this class must not perform any operations that can throw an exception. if it does, the exception guarantees of derived iterators will be broken. so like… behave. 😭

🧚 Constructor & Destructor Documentation 🧚

__gnu_debug::_Safe_local_iterator_base::_Safe_local_iterator_base ()

[inline], [protected]

initializes the iterator and makes it singular. she's alone, she's unbothered, she's singular. 💅

Referenced by _Safe_local_iterator_base().

__gnu_debug::_Safe_local_iterator_base::_Safe_local_iterator_base (const _Safe_unordered_container_base * __seq, bool __constant)

[inline], [protected]

initialize the iterator to reference the container pointed to by __seq. __constant is true when we are initializing a constant local iterator, and false if it's a mutable local iterator. note that __seq may be NULL, in which case the iterator will be singular. otherwise, the iterator will reference __seq and be nonsingular. 🌟

References _M_attach().

__gnu_debug::_Safe_local_iterator_base::_Safe_local_iterator_base (const _Safe_local_iterator_base & __x, bool __constant)

[inline], [protected]

initializes the iterator to reference the same container that __x does. __constant is true if this is a constant iterator, and false if it is mutable.

References _Safe_local_iterator_base(), and _M_attach().

💜 Member Function Documentation 💜

void __gnu_debug::_Safe_iterator_base::_M_attach (const _Safe_sequence_base * __seq, bool __constant)

[protected], [inherited]

attaches this iterator to the given sequence, detaching it from whatever sequence it was attached to originally. if the new sequence is the NULL pointer, the iterator is left unattached. no home, no problem. 🙈

References _M_attach().

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach(), and _M_attach().

void __gnu_debug::_Safe_local_iterator_base::_M_attach (const _Safe_unordered_container_base * __cont, bool __constant)

[protected]

attaches this iterator to the given container, detaching it from whatever container it was attached to originally. if the new container is the NULL pointer, the iterator is left unattached.

Referenced by _Safe_local_iterator_base(), _Safe_local_iterator_base(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_M_attach().

void __gnu_debug::_Safe_iterator_base::_M_attach_single (const _Safe_sequence_base * __seq, bool __constant)

[protected], [noexcept], [inherited]

likewise, but not thread-safe. ⚠️ same energy as _M_attach, just without the safety net.

References _M_attach_single().

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach_single(), and _M_attach_single().

void __gnu_debug::_Safe_local_iterator_base::_M_attach_single (const _Safe_unordered_container_base * __cont, bool __constant)

[protected], [noexcept]

likewise, but not thread-safe. ⚠️

Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_M_attach_single().

bool __gnu_debug::_Safe_iterator_base::_M_attached_to (const _Safe_sequence_base * __seq) const

[inline], [inherited]

determines if we are attached to the given sequence. are we linked up or not, bestie? 👀

References _M_attached_to(), and _M_sequence.

Referenced by _M_attached_to().

bool __gnu_debug::_Safe_iterator_base::_M_can_compare (const _Safe_iterator_base & __x) const

[noexcept], [inherited]

can we compare this iterator to the given iterator __x? returns true if both iterators are nonsingular and reference the same sequence. if not… they're not even in the same friend group, so no. ✋

References _Safe_iterator_base(), and _M_can_compare().

Referenced by _M_can_compare().

void __gnu_debug::_Safe_local_iterator_base::_M_detach ()

[protected]

detach the iterator for whatever container it is attached to, if any. bye bestie, you're on your own now. 🦋

Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=().

void __gnu_debug::_Safe_local_iterator_base::_M_detach_single ()

[protected], [noexcept]

likewise, but not thread-safe. ⚠️

__gnu_cxx::__mutex & __gnu_debug::_Safe_iterator_base::_M_get_mutex ()

[protected], [noexcept], [inherited]

for use in _Safe_iterator. she's the bouncer at the club, keeping things orderly. 🔐

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator++(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator++(), __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=().

void __gnu_debug::_Safe_iterator_base::_M_invalidate ()

[inline], [inherited]

invalidate the iterator, making it singular. she's gone. iconic exit. 💀

References _M_invalidate(), and _M_version.

Referenced by _M_invalidate().

void __gnu_debug::_Safe_iterator_base::_M_reset ()

[noexcept], [inherited]

reset all member variables. fresh start, clean slate, new era. 🎀

bool __gnu_debug::_Safe_iterator_base::_M_singular () const

[noexcept], [inherited]

is this iterator singular? yes or no, bestie, that's the whole question. 💅

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::__check_singular_aux(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_dereferenceable(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_M_dereferenceable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_incrementable(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_M_incrementable(), __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=().

[inline], [noexcept], [inherited]

unlink itself. removing herself from the group chat, respectfully. 🫶

References _M_next, _M_prior, and _M_unlink().

Referenced by _M_unlink().

part 2 is coming bestie, don't go anywhere 💜

✨ Member Data Documentation ✨

Okay bestie, gather round 🫶 this is the data-member lore for __gnu_debug::_Safe_iterator_base — every single one is inherited, and they're all lowkey iconic. No skips, no summaries, periodt.

💖 _Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_next [inherited]

Pointer to the next iterator in the sequence's list of iterators. Only valid when _M_sequence != NULL.

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), and _M_unlink().

💖 _Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_prior [inherited]

Pointer to the previous iterator in the sequence's list of iterators. Only valid when _M_sequence != NULL.

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), and _M_unlink().

💖 const _Safe_sequence_base* __gnu_debug::_Safe_iterator_base::_M_sequence [inherited]

The sequence this iterator references; may be NULL to indicate a singular iterator. Stored as pointer-to-const because sequence could be declared as const.

Referenced by:

  • __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator()
  • __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator()
  • __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator()
  • _Safe_iterator_base()
  • _Safe_iterator_base()
  • _Safe_iterator_base()
  • _M_attached_to()
  • __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=()
  • __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=()

💖 unsigned int __gnu_debug::_Safe_iterator_base::_M_version [inherited]

The version number of this iterator. The sentinel value 0 is used to indicate an invalidated iterator (i.e., one that is singular because of an operation on the container). This version number must equal the version number in the sequence referenced by _M_sequence for the iterator to be non-singular.

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), _M_invalidate(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

✨ Author ✨

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

Okay so the footer vibe check: it's tagged as libstdc++ and __gnu_debu...rator_base(3), with the date slot lowkey empty in this snippet. So that's the source/version and date tea, bestie — bye, go be safe with your iterators 💅🦋

📦 where this page comes from
  • arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 · GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
  • fedora 44: libstdc++-docs 16.0.1-0.10.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 44: libstdc++-docs 16.2.1-2.fc44
  • fedora 44: libstdc++-docs 16.2.1-3.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms